Changes the status of a task from requested to in-progress and start its execution.
The required param of execId is supposed to be received from the requestawf.task/poll or awf.task/long-poll.
Params:
Result:
POST /rpccontent-type:text/yamlaccept:text/yamlmethod:awf.task/startparams:id:c578a224-c1fa-44c1-bc7a-9d2e624b872bexecId:aac4c869-daa4-45fb-917a-46fe14359ed4
These parameters with notification type will be recorded in AidboxTaskLog resource after handling API request.
For heartbeat Notification Type :
For progress Notification Type :
Result:
POST /rpccontent-type:text/yamlaccept:text/yamlmethod:awf.task/notifyparams:id:3abf82be-ec63-4fb4-908a-21d91b2d4af9execId:292e9f34-c275-4cd3-840f-b4c39d0512e4notification:awf.task/heartbeatmessage:"task is alive"
Changes the status of a task from in-progress to done, setting the outcome to succeeded.
Params:
Result:
POST /rpccontent-type:text/yamlaccept:text/yamlmethod:awf.task/successparams:id:c578a224-c1fa-44c1-bc7a-9d2e624b872bexecId:aac4c869-daa4-45fb-917a-46fe14359ed4
Changes the status of a task from in-progress to done, setting the outcome to failed.
Params:
Result:
POST /rpccontent-type:text/yamlaccept:text/yamlmethod:awf.task/failparams:id:7572b48b-7196-4887-bab7-a78bf09bdd83execId:d9bdbaa7-35ee-4234-a603-990a6a5dd559
result:resource:definition:aidbox.bulk/import-resource-taskmeta:lastUpdated:'2023-05-05T14:15:49.658083Z'createdAt:'2023-05-05T14:12:52.899952Z'versionId:'128620'params:type:aidboxinput:url:>- https://storage.googleapis.com/aidbox-public/synthea/100/Organization.ndjson.gzresourceType:OrganizationretryCount:2outcome:failedresourceType:AidboxTaskstatus:doneexecId:d9bdbaa7-35ee-4234-a603-990a6a5dd559id:>- 7572b48b-7196-4887-bab7-a78bf09bdd83outcomeReason:type:awf.task/failed-by-executormessage:Failed by executor
Last updated
Parameter
Type
Required
Description
Parameter
Type
Description
Parameter
Type
Required
Description
Parameter
Type
Description
Parameter
Type
Required
Description
Parameter
Type
Description
Notification Type
Description
Parameter
Type
Required
Description
Parameter
Type
Required
Description
Parameter
Type
Required
Description
Parameter
Type
Description
Parameter
Type
Required
Description
Parameter
Type
Description
Parameter
Type
Required
Description
Parameter
Type
Description
taskDefinitions
string[]
An array of task definitions to include.
workflowDefinitions
string[]
An array of workflow definitions to include. In response, decision tasks will be returned for specified workflow if available.
maxBatchSize
integer
The number of tasks that can be polled from the queue simultaneously.
Default value: 1
resources
object[]
AidboxTask resources with execId.
taskDefinitions
string[]
An array of task definitions to include.
workflowDefinitions
string[]
An array of workflow definitions to include. In response, decision tasks will be returned for specified workflow if available.
maxBatchSize
integer
The number of tasks that can be polled from the queue simultaneously.
Default value: 1
timeout
integer
A period of time in ms, the period of time during which the tasks can be polled.
Default value: 60000 (equal to 1 minute)
resources
object[]
AidboxTask resources with execId.
id
string
Identifier of the Task resource.
execId
string
Execution id of the task. Used to avoid duplicate task executions.
resource
object
Started AidboxTask resource.
heartbeat
Prolongs the inProgressTimeout property of the task and sends a string message.
progress
Prolongs the inProgressTimeout property of the task and sends information about its progress.
id
string
Identifier of the Task resource.
execId
string
Execution id of the task. Used to avoid duplicate task executions.
notification
string
The type of notification depends on which extra parameters may be required.
Possible values: heartbeat, progress
message
string
A string message about any additional information.
progress-current
integer
The current value of progress in an integer
(The numerator of current / total).
progress-total
integer
The total value of progress in an integer
(The dominator of current / total).
progress-unit
string
The unit for the values of progress-total and progress-current.
Example: rows
inProgressTimeoutAt
integer
The renewed inProgressTimeout property of the task.
id
string
Identifier of the Task resource.
execId
string
Execution id of the task. Used to avoid duplicate task executions.
result
object
Result with which task was succeeded.
resource
object
Succeeded AidboxTask resource.
id
string
Identifier of the Task resource.
execId
string
Execution id of the task. Used to avoid duplicate task executions.