Workflow Request API
Workflow Request can be accessed through this API using GET.
GET
GET by Id
This GET service will find a workflow request using Id and return the JSON representation of the object.
API URL
http://host:port/flexdeploy/rest/v1/workflowrequest/{workflowRequestId}
Request
Parameter | Type | Required | Description |
|---|---|---|---|
Id | URL | Yes | This is a URL parameter for the Id which is used to find and return a workflow request. |
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 | Id of project version |
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. Most of the statuses are interim statuses, only COMPLETED and FAILED are final status. 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 | Code/value pairs for the FlexFields |
projectId | Long | Id of the project the workflow request is associated with |
folderId | Long | Folder that contains project or Application for folder request |
folderName | String | Name of Folder or Application |
projectStreamId | Long | Id of the stream requested to be executed on |
force | Boolean | True if force build or deploy |
cmsissues | String | Issues in Change Management System |
projectVersionName | String | Name of project version |
environmentId | Long | Id of the environment requested to be executed on |
folderVersionId | Long | Folder version id if application build or deploy is done. |
exceptionToWindow | Boolean | True if user requested exception to window. |
Response Codes
HTTP Code | Description |
|---|---|
200 | Workflow request was found and returned |
401 | Authentication failure |
403 | Authorization failure (no access to resource) |
404 | Workflow request not found |
500 | Unexpected internal server error |
Example
If a workflow request has an id of 86301 and a GET request was sent to http://host:port/flexdeploy/v1/rest/workflowrequest/86301
a workflow request JSON object will be returned with the following information:
{
"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
}- style