Summary
Finish a task
Description
Finish a task and set its output data.
Route
POST /workflow_engine/jobs/finish_task/:job_id/:task_id
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| job_id | string | yes | ID of the job. |
| task_id | string | yes | ID of the Task within that job. |
| task_data | object | yes | Data of the completed Task. |
{ "task_data": { "finish_state": "loop", "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": null }, "error": "" } } }
{ "type": "object", "properties": { "task_data": { "type": "object", "properties": { "finish_state": { "$ref": "jobsDocument#/definitions/jobTaskFinishState" }, "variables": { "$ref": "taskDocument#/definitions/variables" } } } }, "required": [ "task_data" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| job_details | object | The current job object. |
{ "_id": "5cb7b531d06cceb89fd21b1c", "name": "8917Test2", "tasks": { "workflow_start": { "name": "TestTask", "summary": "Test Task", "displayName": "WorkflowBuilder", "type": "automated", "x": 0.36142061281337046, "y": 0.502092050209205, "status": "complete", "groups": [], "metrics": { "owner": "Pronghorn", "start_time": 1555430149763, "end_time": 1555430169683, "run_time": 75069184, "finish_state": "canceled", "server_id": "ac:de:48:00:11:22:3000", "app": { "id": "WorkflowBuilder", "version": "1.2.3" } }, "description": "Test Task", "app": "WorkflowBuilder", "canvasName": "taskName1", "canvasTab": "taskName1", "view": "/workflow_builder/task/TestTask", "deprecated": false, "scheduled": false, "iterations": [ "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": null }, "error": "" }, "childJobs": [ { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 } ] }, "workflow_end": { "name": "TestTask", "summary": "Test Task", "displayName": "WorkflowBuilder", "type": "automated", "x": 0.36142061281337046, "y": 0.502092050209205, "status": "complete", "groups": [], "metrics": { "owner": "Pronghorn", "start_time": 1555430149763, "end_time": 1555430169683, "run_time": 75069184, "finish_state": "canceled", "server_id": "ac:de:48:00:11:22:3000", "app": { "id": "MOP", "version": "1.2.3" } }, "description": "Test Task", "app": "WorkflowBuilder", "canvasName": "taskName1", "canvasTab": "taskName1", "view": "/workflow_builder/task/TestTask", "deprecated": false, "scheduled": false, "iterations": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad" ], "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": null }, "error": "" }, "childJobs": [ { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 } ] }, "error_handler": { "name": "TestTask", "summary": "Test Task", "description": "Test Task", "app": "WorkflowBuilder", "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": null }, "error": "" }, "groups": [ "d6b503d6ae9beb55a2e0c6bd", "400cae1446094bb0e17e0513", "9c628ccd0bc2ea0f54ae9c66", "56706b8054545c7a294a007c" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "automated", "displayName": "WorkflowBuilder", "status": "complete", "deprecated": false, "scheduled": false, "canvasName": "taskName1", "canvasTab": "taskName1", "view": "/workflow_builder/task/TestTask", "metrics": { "owner": "reprehenderit adipisicing", "start_time": 1555430149763, "end_time": 1555430169683, "run_time": 75069184, "finish_state": "success", "server_id": "ac:de:48:00:11:22:3000", "app": { "id": "WorkFlowEngine", "version": "1.2.3" } }, "iterations": [ "4321abcdef694aa79dae47ad" ], "childJobs": [ { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 } ] }, "e": { "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", "view": "/workflow_builder/task/TestTask", "deprecated": false, "scheduled": false, "metrics": { "owner": "tempor", "start_time": 1555430149763, "end_time": 1555430169683, "run_time": 75069184, "finish_state": "success", "server_id": "ac:de:48:00:11:22:3000", "app": { "id": "WorkFlowEngine", "version": "1.2.3" } }, "iterations": [ "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad" ], "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": null }, "error": "" }, "childJobs": [ { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 } ] } }, "transitions": { "workflow_start": { "6a90": { "type": "standard", "state": "success" } }, "6a90": { "workflow_end": { "type": "standard", "state": "success" } } }, "font_size": 12, "created": "2018-07-26T19:37:05.000Z", "created_by": "admin@pronghorn", "last_updated": "2018-08-02T15:56:12.912Z", "last_updated_by": "5b3496d74da02e9dfa0b2e91", "groups": [], "type": "automation", "watchers": [ "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "metrics": { "owner": "5a3496c64da02d9dfa0b2f91", "start_time": 1555430149763, "end_time": 1555430169683, "run_time": 75069184, "finish_state": "error", "server_id": "ac:de:48:00:11:22:3000", "app": { "id": "WorkflowBuilder", "version": "1.2.3" } }, "status": "canceled", "lastUpdatedVersion": "ex sunt exercitation occaecat magna", "canvasVersion": 2, "ancestors": [ "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c" ], "error": [ { "task": "job", "message": "No available transitions found from completed task(s)", "timestamp": 1555471643117 }, { "task": "job", "message": "No available transitions found from completed task(s)", "timestamp": 1555471643117 }, { "task": "job", "message": "No available transitions found from completed task(s)", "timestamp": 1555471643117 }, { "task": "job", "message": "No available transitions found from completed task(s)", "timestamp": 1555471643117 }, { "task": "job", "message": "No available transitions found from completed task(s)", "timestamp": 1555471643117 } ] }
{ "$ref": "jobsDocument" }