How to: Manage Mobile APIs

3min

For information about prerequisites, see Integrate with Dispatch﻿.
Update Execution Task Status
To update the Execution Task status, call the Update Execution Task Status﻿ endpoint and pass the following required members in the request body. Also, specify the workflowInstanceId and taskId in the path parameter.
Member
Description
Remarks
jobId
ID of the Job
string
dispatchId
ID of the Dispatch
string
attemptId
Attempt number of the workflow instance
number
status
Status of the task
stringEnum: [ STARTED, CLOSED ]
sequenceId
Sequence number of the Execution Task
number
stateName
Task/state name of the taskId
string
timestamp
Epoch timestamp of the status
number
minimum: 1
data
Output of the Execution Task
﻿
meta
Meta data related to the Task
﻿
updatedBy > id
ID
string
minLength: 1
maxLength: 64
updatedBy > name
Name
string
maxLength: 256
updatedBy > appId
App ID
string
maxLength: 64
The JSON request body should be similar to the following:
JSON
{
  "jobId": "string",
  "dispatchId": "string",
  "attemptId": 0,
  "status": "STARTED",
  "sequenceId": 0,
  "stateName": "string",
  "timestamp": 1,
  "data": {},
  "meta": {},
  "updatedBy": {
    "id": "string",
    "name": "string",
    "appId": "string"
  },
  "_event_meta": {}
}
{
  "jobId": "string",
  "dispatchId": "string",
  "attemptId": 0,
  "status": "STARTED",
  "sequenceId": 0,
  "stateName": "string",
  "timestamp": 1,
  "data": {},
  "meta": {},
  "updatedBy": {
    "id": "string",
    "name": "string",
    "appId": "string"
  },
  "_event_meta": {}
}
﻿
Update Execution Workflow Status
To update the Execution Workflow status, call the Update Execution Task Status﻿ endpoint and pass the following required members in the request body. Also, specify the workflowInstanceId in the path parameter.
Member
Description
Remarks
status
Status of the workflow
string
Enum: [ STARTED, CLOSED ]
timestamp
Epoch timestamp of the status
number
minimum: 1
dispatchId
ID of the Dispatch
string
jobId
ID of the Job
string
attemptId
Attempt number of the workflow instance
number
code
Workflow objective code
string
data
Collated data of output of each execution task
﻿
meta
Metadata related to the Workflow
﻿
updatedBy > id
ID
string
minLength: 1
maxLength: 64
updatedBy > name
Name
string
maxLength: 256
updatedBy > appId
App ID
string
maxLength: 64
The JSON request body should be similar to the following:
JSON
{
  "status": "STARTED",
  "timestamp": 1,
  "dispatchId": "string",
  "jobId": "string",
  "attemptId": 0,
  "closeJob": true,
  "data": {},
  "meta": {},
  "code": "string",
  "updatedBy": {
    "id": "string",
    "name": "string",
    "appId": "string"
  },
  "_event_meta": {}
}
{
  "status": "STARTED",
  "timestamp": 1,
  "dispatchId": "string",
  "jobId": "string",
  "attemptId": 0,
  "closeJob": true,
  "data": {},
  "meta": {},
  "code": "string",
  "updatedBy": {
    "id": "string",
    "name": "string",
    "appId": "string"
  },
  "_event_meta": {}
}
﻿
﻿

Member	Description	Remarks
jobId	ID of the Job	string
dispatchId	ID of the Dispatch	string
attemptId	Attempt number of the workflow instance	number
status	Status of the task	stringEnum: [ STARTED, CLOSED ]
sequenceId	Sequence number of the Execution Task	number
stateName	Task/state name of the taskId	string
timestamp	Epoch timestamp of the status	number minimum: 1
data	Output of the Execution Task
meta	Meta data related to the Task
updatedBy > id	ID	string minLength: 1 maxLength: 64
updatedBy > name	Name	string maxLength: 256
updatedBy > appId	App ID	string maxLength: 64

Member	Description	Remarks
status	Status of the workflow	string Enum: [ STARTED, CLOSED ]
timestamp	Epoch timestamp of the status	number minimum: 1
dispatchId	ID of the Dispatch	string
jobId	ID of the Job	string
attemptId	Attempt number of the workflow instance	number
code	Workflow objective code	string
data	Collated data of output of each execution task
meta	Metadata related to the Workflow
updatedBy > id	ID	string minLength: 1 maxLength: 64
updatedBy > name	Name	string maxLength: 256
updatedBy > appId	App ID	string maxLength: 64

Updated 03 Aug 2023

Did this page help you?

How to: Manage Dispatch

How to: Manage Ledger