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

authentication

Y

Object

The authentication parameter is comprised of 2 fields.

userId – a valid user id for FlexDeploy
password – the associated password

workflowRequestId

Y

Long

The requestId to retrieve the status for.

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",
   "projectWorkflowId": 3882242,
   "environmentId": 10140,
   "folderVersionId": null,
   "exceptionToWindow": false
}