getWorkflowRequest (version 0)
This POST service will retrieve the workflowRequest
based on the workflowRequestId
in the request.
WorkflowRequest contains Status, most of the statuses are interim statuses, only COMPLETED
and FAILED
are final status. Your request will fall into one of these two upon completion. The following are all of the possible statuses that can be returned:
INITIATED
PENDING_APPROVAL
SCHEDULED
ABORTED
REJECTED
READY
SUBMITTED
COMPLETED
FAILED
API URL
http://host:port/flexdeploy/rest/workflow/getWorkflowRequest
Sample JSON Request
{ "authentication": { "userId": "userid", "password": "mypassword" }, "workflowRequestId": 28208 }
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
| Y | Object | The
|
| Y | Long | The |
Response
Attribute | Type | Description |
---|---|---|
requestedBy | String | User name that requested workflow execution. This can be internal user like cipoller as well. |
packageName | String | Only for partial deployment projects where package based build or deploy is executed. |
workflowRequestId | Long | Id of workflow request |
projectVersionId | Long | Project version id |
folderRequestId | Long | Only present if application build or deploy is requested. |
requestedStartTime | Timestamp | Only present for deploy and if user has requested specific time for execution. |
workflowRequestStatus | String | Status of workflow request. Possible values are INITIATED, PENDING_APPROVAL, SCHEDULED, ABORTED, REJECTED, READY, SUBMITTED, COMPLETED, FAILED. FAILED and COMPLETED are failure or success statuses. |
stopOnPackageError | Boolean | Only for partial deployment project deploy execution. |
workflowOverrideVersion | String | If user requested non active workflow version to be executed. |
releaseSnapshotId | Long | Only returned for specific cases. 1) deployment is done via pipeline, 2) build was done using Create Snapshot screen action or API. |
requestAllFiles | Boolean | Only for partial deployment project, true if user requested build or deploy of All Files. |
releaseDefinitionId | Long | Only returned if build or deploy was executed with release. |
projectName | String | Name of project |
folderPath | String | Folder path that contains project |
flexFields | Array of Code and Value | |
projectId | Long | Project Id |
folderId | Long | Folder that contains project or Application for folder request |
folderName | String | Name of Folder or Application |
projectStreamId | Long | Stream Id |
force | Boolean | True if force build or deploy |
cmsissues | String | |
projectVersionName | String | Project version name |
environmentId | Long | Environment Id |
folderVersionId | Long | Folder version id if application build or deploy is done. |
exceptionToWindow | Boolean | True if user requested exception to window. |
Example Response
{ "requestedBy": "cideploy", "packageName": null, "workflowRequestId": 86301, "projectVersionId": 4051785, "folderRequestId": null, "requestedStartTime": null, "workflowRequestStatus": "FAILED", "stopOnPackageError": false, "workflowOverrideVersion": null, "releaseSnapshotId": null, "requestAllFiles": true, "releaseDefinitionId": null, "projectName": "XXHR", "folderPath": "FlexDeploy/EBS", "flexFields": [ { "value": "A", "code": "DEPLOY_CHANGE_NUMBER" }], "projectId": 3882238, "folderId": 3871702, "folderName": "EBS", "projectStreamId": 3882239, "force": false, "cmsissues": "", "projectVersionName": "1.0.29", "environmentId": 10140, "folderVersionId": null, "exceptionToWindow": false }
The following macros are not currently supported in the footer:
- style