This POST service will retrieve the workflowRequestStatus
based on the workflowRequestId
in the request. 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
REJECTED
READY
SUBMITTED
COMPLETED
FAILED
API URL
http://host:port/flexdeploy/rest/workflow/getWorkflowRequestStatus
{ "authentication": { "userId": "userid", "password": "mypassword" }, "workflowRequestId": "28208" }
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
| Y | String | See Common Parameters below. |
| Y | Long | The |
Common Parameters
Authentication
The authentication
parameter is comprised of 2 fields.
userId
– a valid user id for FlexDeploypassword
– the associated password
Inputs
This is a list of code/value
pairs for the inputs. Not all inputs need to be supplied. If an input has a default value that is acceptable for the Workflow to run, it does not need to be supplied.
FlexFields
This is a list of the code/value
pairs for the Flexfields (not the Display Name). Not all FlexFields need to be supplied. If a FlexField has a default value or options that are acceptable for the workflow to run, it does not need to be changed. Read more about FlexFields.