Summary
Claim Task
Description
Claim a manual Task
Route
POST /workflow_engine/tasks/claim
Roles
admin
engineering
support
apiwrite
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| task_id |
string |
yes |
ID of the Task to claim. |
| user |
string |
yes |
User id for the user claiming the Task. |
Copied to Clipboard
{
"task_id": "12ab",
"user": "5cb7b531d06cceb89fd21b1c"
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| data |
object |
Result of claiming the Task. |
Copied to Clipboard
{
"name": "TestTask",
"summary": "Test Task",
"displayName": "WorkflowBuilder",
"type": "automated",
"x": 0.36142061281337046,
"y": 0.502092050209205,
"status": "complete",
"description": "Test Task",
"app": "WorkflowBuilder",
"canvasName": "taskName1",
"canvasTab": "taskName1",
"sla": 3600000,
"view": "/workflow_builder/task/TestTask",
"deprecated": false,
"scheduled": false,
"metrics": {
"owner": "5a3496c64da02d9dfa0b2f91",
"start_time": 1555430149763,
"end_time": 1555430169683,
"run_time": 75069184,
"finish_state": "success",
"claim_time": 75069184,
"server_id": "ac:de:48:00:11:22:3000",
"app": {
"id": "WorkflowBuilder",
"version": "3.2.1"
}
},
"iterations": [
"5cb7b531d06cceb89fd21b1c",
"4321abcdef694aa79dae47ad"
],
"variables": {
"incoming": {
"inputVariable": "inputValue"
},
"outgoing": {
"outputVariable": null
},
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/outgoing/output"
},
{
"type": "encryption",
"pointer": "/outgoing/output"
},
{
"type": "encryption",
"pointer": "/outgoing/output"
}
]
},
"childJobs": [
{
"_id": "5cb7b531d06cceb89fd21b1c",
"name": "ChildJobRef",
"iteration": 1
},
{
"_id": "5cb7b531d06cceb89fd21b1c",
"name": "ChildJobRef",
"iteration": 1
}
],
"retrySettings": {
"ref": "wfEngineCommon#/definitions/retrySettings"
}
}
