This POST service will retrieve the workflowRequest based on the workflowRequestId in the request.
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"authentication":
{
"userId": "userid",
"password": "mypassword"
},
"workflowRequestId": 28208
} |
Parameters
Parameter | Required | Type | Description |
|---|---|---|---|
| Y | Object | The
|
| Y | Long | The |
Response
| Attribute | Type | Description |
|---|---|---|
| requestedBy | ||
| packageName | ||
| workflowRequestId | ||
| projectVersionId | ||
| folderRequestId | ||
| requestedStartTime | ||
| workflowRequestStatus | ||
| stopOnPackageError | ||
| workflowOverrideVersion | ||
| 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 | ||
| releaseDefinitionId | Long | Only returned if build or deploy was executed with release. |
| projectName | ||
| folderPath | ||
| flexFields | ||
| projectId | ||
| folderId | ||
| folderName | ||
| projectStreamId | ||
| force | ||
| cmsissues | ||
| projectVersionName | ||
| environmentId | ||
| folderVersionId | ||
| exceptionToWindow |
Example Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"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",
"projectWorkflowId": 3882242,
"environmentId": 10140,
"folderVersionId": null,
"exceptionToWindow": false
} |
...