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

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.

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
projectVersionIdLongProject version id
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.

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 Value
projectIdLongProject Id
folderIdLongFolder that contains project or Application for folder request
folderNameStringName of Folder or Application
projectStreamIdLongStream Id
forceBooleanTrue if force build or deploy
cmsissuesString
projectVersionNameStringProject version name
environmentIdLongEnvironment Id
folderVersionIdLongFolder version id if application build or deploy is done.
exceptionToWindowBooleanTrue 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