This POST service will perform the same action found on the "Deployment Request Form" off the application screen. It will initiate a request to deploy the application selected in the qualifiedApplicationName. The service will return the workflowRequestId applicationRequestId which can be used by the getWorkflowRequestStatus getApplicationRequestStatus (version 0) call to determine when the workflow is complete.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/workflow/deployApplication | ||
| Code Block | ||
| language | js | title |
...
Application Deploy Sample JSON Request |
|---|
...
{ |
...
|
...
"authentication": |
...
{ |
...
"userId": |
...
"fdadmin", |
...
|
...
"password": " |
...
password1" |
...
}, | Opening bracket Authentication section, used on all types of requests. |
Required parameters for application deployment. | |
|---|---|
"environmentCode":"DEV","qualifiedApplicationName":"/FlexDeploy/folder1/myApp", | Build in the DEV environment. The full path of the FlexDeploy project to deploy. |
Optionally include this information. Verify that your json is valid; check for trailing commas if you don't include this section. | |
"forceDeploy": true, "startTime": "2017-03-16T23:17:52-06:00", | |
...
"exceptionToWindow": "true","applicationVersion": " |
...
1.5","projectSettings": [ { |
...
"projectName": "SimpleProj", |
...
"inputs": [ |
...
{
" |
...
code": " |
...
inp1", "value": " |
...
value1" |
...
}, |
...
{
" |
...
code": " |
...
inp2", "value": " |
...
value2" |
...
}]
} |
...
],
|
...
" |
...
code": " |
...
CHANGE_NUMBER", |
...
"value": "xyz"
"code": " |
...
field2", |
...
"value": |
...
123
| boolean equivalent to "Force Deploy" checkbox in the UI. Defaults to false. Start the deployment at this time. The application will be deployed outside any configured windows. Version "1.5" of the application will be deployed. List of projects in the application SimpleProj will be deployed using the two listed Input Codes. Any other projects in the application which do not need inputs will still be deployed, even if they are not listed in the JSON. List of FlexField codes to set Set CHANGE_NUMBER to "xyz" Set field2 to 123. Change Ticket number for configured Change Management System Setting the value of the Change Ticket to "REQ0010015" |
| } | Closing bracket |
Parameters
Parameter | Required | Type | Description |
|---|---|---|---|
| Y | Object | See Common Parameters below. |
| Y | String | This is the environment code, not the environment name that you see on most screens. |
| Y | String | The qualified application name starts with /FlexDeploy and includes any sub folders, and finally the project. |
applicationVersion | N | String | Version of the application to be deployed. Defaults to the last successful build. |
| N | Boolean | Values are true or false. Indicates that the deployment is an exception to the deployment window. |
| forceBuildN | Boolean | Values are true or false. Indicates that the build deployment should occur even if there are not SCM changes |
qualifiedApplicationName | Y | String | The qualified application name starts with /FlexDeploy and includes any sub folders, and finally the project. |
StartTime | when the | ||
| N | DateTime | The time when the deployment will be started. |
ProjectSettings | N | Array | The project settings is a list of the projects by name and includes the 2 sub-parameters below. If all values can be defaulted, the project setting for that project does not need to be included. |
projectName | N | String | The project nameinputsto assign inputs into |
inputs | N | Array | See Common Parameters below. |
| N | Array | See Common Parameters below. |
changeTicket | N | String | Ticket number for the given deployment, using the configured Change Management System. |
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|