- style
deployApplication
This 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
which can be used by the getWorkflowRequestStatus
call to determine when the workflow is complete.
API URL
http://host:port/flexdeploy/rest/workflow/deployApplication
{ "authentication": { "userId": "fdadmin", "password": "password123" }, "applicationVersion": "1.5", "environmentCode": "DEV", "exceptionToWindow": "true", "forceDeploy": "true", "qualifiedApplicationName": "/FlexDeploy/test20", "startTime": "2015-03-16T23:17:52-06:00", "flexFields": [ { "name": "field1","value": "xyz" }, { "name": "field2","value": "123" }], "projectSettings": [ { "projectName": "SimpleProj", "inputs": [ { "name": "i1", "value": "dfg" }, { "name": "i2", "value": "wer" }] }, { "projectName": "SimpleTest", "inputs": [ { "name": "input1", "value": "asd" }, { "name": "input2", "value": "zxc" }] }] }
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
authentication | Y |
| See Common Parameters |
environmentCode | Y | String | This is the environment code, not the environment name that you see on most screens. |
exceptionToWindow |
| Boolean | Values are true or false. Indicates that the deployment is an exception to the deployment window. |
forceBuild |
| Boolean | Values are true or false. Indicates that the build 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 |
| DateTime | The time when the deployment will be started. |
ProjectSettings |
|
| 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 |
|
| The project name |
inputs |
|
| See Common Parameters |
flexFields |
|
| See Common Parameters |
Authentication
The authentication parameter is comprised of 2 fields.
- userId – a valid user id for FlexDeploy
- password – the associated password
Inputs
This is a list of name/value pairs for the inputs. Not all inputs need to be supplied. If an input has a default value that is acceptable for the workflow to run, it does not need to be changed.
Flex Fields
Applicable only for deployProject and deployApplication. This is a list of name (Display Name of FlexField)/value pairs for the FlexFields. Not all FlexFields need to be supplied. If a flex field has a default value or options that are acceptable for the workflow to run, it does not need to be changed.
InstanceCodes
The list of instances where the deployment will occur.
- style