This POST service will perform the same action found on the Deployment Request Form off the project screen. It will initiate a request to deploy the project specified with the project Id. The service will return the workflowRequestId which can be used by the getWorkflowRequestStatus call to determine the workflow is complete.
...
Response
| Attribute | Type | Description | workflowRequestId|
|---|---|---|---|
| warningMessage | String | Returns the workflow request id that was just submitted. | Indicates any warning message in the event where the request was successful but no new deployment was initiated. For example: Project Version is already deployed and force deploy wasn't specified |
| warningCode | String | Matching warning code for the warning message. | |
| workflowRequests | Array | Array of workflow request objects |
Response Codes
| HTTP Code | Description |
|---|---|
| 200 | Project version already deployed |
| 201 | Project was built Deploy request initiated successfully |
| 400 | Bad request |
| 401 | Unauthorized |
| 404 | Project not found |
| 500 | Unexpected internal server error |
...
In response, we will receive the workflowRequestId:12100an array of workflowRequests:
| Code Block | ||
|---|---|---|
| ||
{
"warningMessage": null,
"warningCode": null,
"workflowRequests": [
{
"packageName": null,
"folderName": "Human Resources",
"releaseSnapshotId": null,
"workflowRequestStatus": "READY",
"folderId": 10001,
"exceptionToWindow": false,
"releaseDefinitionId": null,
"cmsissues": "",
"workflowRequestId": 12001,
"projectName": "ProcessHRRequest",
"projectStreamId": 10502,
"projectVersionName": "1.0.8",
"requestAllFiles": false,
"projectVersionId": 29201,
"environmentId": 11210,
"folderRequestId": null,
"flexFields": [],
"folderPath": "FlexDeploy/Human Resources",
"projectId": 10501,
"requestedBy": "fdadmin",
"requestedStartTime": null,
"force": true,
"stopOnPackageError": null,
"workflowOverrideVersion": null,
"folderVersionId": null
}
]
} |