Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

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 workflow request using Id and return the JSON representation of the object. 

API URL

http://host:port/flexdeploy/rest/v1/workflowrequest/{Id}

Request

Parameter

Type

Required

Description

Id

URLYesThis is a URL parameter for the Id which is used to find and return an approval task.

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.

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 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
}
  • No labels