Dispatch Service
Mobile APIs
Status update for an Execution Workflow
1min
POST
PATH PARAMETERS
workflowInstanceId
string
*Workflow Instance ID
HEADER PARAMETERS
X-COREOS-REQUEST-ID
string
*Unique RequestId
X-COREOS-TID
string
*Tenant id
X-COREOS-ACCESS
string
*Access Token
X-COREOS-USERINFO
string
*user info
BODY PARAMETERS
body
ExecutionWorkflowStatus
*Update status of execution workflow
status
string<STARTED | CLOSED>
*Status of workflow
timestamp
number
*Epoch timestamp of the status
dispatchId
string
*Dispatch id
jobId
string
*Job Id
attemptId
number
*Attempt number of the workflow-instance
closeJob
boolean
If job can be closed
data
object
*Example: [object Object]
Collated data of output of each execution task
meta
object
*Example: [object Object]
Meta data related to workflow
code
string
*Workflow objective code
updatedBy
UpdatedBy
*_event_meta
Meta
Meta data
onRequest
CustomCallRequestObject
onError
CustomCallErrorObject
callback
CallbackObject
RESPONSES
202
OK
SuccessResponse
error
Error
*Error information
request
Request
*data
object
Example: [object Object]
400
Error Occurred
ErrorResponse
error
Error
*Error information
request
Request
*401
Error Occurred
ErrorResponse
error
Error
*Error information
request
Request
*

Updated 03 Aug 2023
Did this page help you?