Workflow Request API

Workflow Request can be accessed through this API using GET.

Authentication - Use Basic Authentication for this API.

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

URLYesThis is a URL parameter for the Id which is used to find and return a workflow request.

Response

AttributeTypeDescription
requestedByStringUser name that requested workflow execution. This can be internal user like cipoller as well.
packageNameStringOnly for partial deployment projects where package based build or deploy is executed.
workflowRequestIdLongId of workflow request
projectVersionIdLongId of project version
folderRequestIdLongOnly present if application build or deploy is requested.
requestedStartTimeTimestampOnly present for deploy and if user has requested specific time for execution.
workflowRequestStatusString

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.

stopOnPackageErrorBooleanOnly for partial deployment project deploy execution.
workflowOverrideVersionStringIf user requested non active workflow version to be executed.
releaseSnapshotIdLongOnly returned for specific cases. 1) deployment is done via pipeline, 2) build was done using Create Snapshot screen action or API.
requestAllFilesBooleanOnly for partial deployment project, true if user requested build or deploy of All Files.
releaseDefinitionIdLongOnly returned if build or deploy was executed with release.
projectNameStringName of project
folderPathStringFolder path that contains project
flexFieldsArray of Code and ValueCode/value pairs for the FlexFields
projectIdLongId of the project the workflow request is associated with
folderIdLongFolder that contains project or Application for folder request
folderNameStringName of Folder or Application
projectStreamIdLongId of the stream requested to be executed on
forceBooleanTrue if force build or deploy
cmsissuesStringIssues in Change Management System
projectVersionNameStringName of project version
environmentIdLongId of the environment requested to be executed on
folderVersionIdLongFolder version id if application build or deploy is done.
exceptionToWindowBooleanTrue if user requested exception to window.

Response Codes

HTTP CodeDescription
200Workflow request was found and returned
401Authentication failure
403Authorization failure (no access to resource)
404Workflow request not found
500Unexpected internal server error

Example

If a workflow request has an id of 86301 and a GET request was sent to http://host:port/flexdeploy/rest/v1/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
}