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": "8085260c-d951-4e5f-9d52-06d911a4eb38",
"user": "5cb7b531d06cceb89fd21b1c"
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| data |
object |
Result of claiming the Task. |
Copied to Clipboard
{
"_id": "8085260c-d951-4e5f-9d52-06d911a4eb38",
"name": "TestTask",
"summary": "Test Task",
"displayName": "WorkflowBuilder",
"type": "automated",
"x": 0.36142061281337046,
"y": 0.502092050209205,
"status": "canceled",
"job": {
"_id": "f80f8dc8b5a04a72bd8dad6c",
"name": "SomeJobName",
"description": "This Job is for doing XYZ when ABC occurs",
"task": "4a89",
"index": 1
},
"iterations": [
"8085260c-d951-4e5f-9d52-06d911a4eb38",
"8085260c-d951-4e5f-9d52-06d911a4eb38",
"8085260c-d951-4e5f-9d52-06d911a4eb38"
],
"description": "Test Task",
"app": "WorkflowBuilder",
"view": "/workflow_builder/task/TestTask",
"deprecated": false,
"scheduled": false,
"metrics": {
"owner": "dolore deserunt nisi dolor",
"start_time": 1555430149763,
"end_time": 1555430169683,
"run_time": 75069184,
"finish_state": "complete",
"server_id": "ac:de:48:00:11:22:3000",
"app": {
"id": "WorkFlowEngine",
"version": "1.2.3"
}
},
"locked": false,
"variables": {
"incoming": {
"inputVariable": "inputValue"
},
"outgoing": {
"outputVariable": "outputValue"
},
"translations": {
"translationVariable": "translationValue"
},
"error": ""
}
}
