Summary
Get Job From Task Query
Description
Search for jobs using a task query.
Route
POST /workflow_engine/getJobFromTaskQuery
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| task_query | object | yes | A mongodb query partial to run against the tasks to get the requested job. |
| options | object | yes | Sort, filter, and pagination options. |
{ "task_query": { "status": "running" } }
{ "type": "object", "properties": { "task_query": { "title": "task_query", "type": "object", "properties": {}, "examples": [ { "status": "running" } ] }, "options": { "properties": {}, "$ref": "wfEngineCommon#/definitions/filteredListSearchOptions" } }, "required": [ "task_query", "options" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| jobs | object | All matching jobs. |
{ "results": [ { "_id": "4321abcdef694aa79dae47ad", "name": "8917Test2", "tasks": { "4": { "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": "95560d460d09c3466dc26ed61f84154516c44a2766dfcca3fdb65e3bc0765b4d", "app": { "id": "WorkFlowEngine", "version": "1.2.3" } }, "iterations": [ "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad" ], "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": null }, "error": "", "decorators": [ { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" } ] }, "childJobs": [ { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 } ], "retrySettings": { "ref": "wfEngineCommon#/definitions/retrySettings" } }, "workflow_start": { "name": "TestTask", "summary": "Test Task", "displayName": "WorkflowBuilder", "type": "automated", "x": 0.36142061281337046, "y": 0.502092050209205, "status": "complete", "groups": [], "metrics": { "owner": "5a3496c64da02d9dfa0b2f91", "start_time": 1555430149763, "end_time": 1555430169683, "run_time": 75069184, "finish_state": "error", "claim_time": 75069184, "server_id": "95560d460d09c3466dc26ed61f84154516c44a2766dfcca3fdb65e3bc0765b4d", "app": { "id": "WorkFlowEngine", "version": "3.2.1" } }, "description": "Test Task", "app": "WorkflowBuilder", "canvasName": "taskName1", "canvasTab": "taskName1", "sla": 3600000, "view": "/workflow_builder/task/TestTask", "deprecated": false, "scheduled": false, "iterations": [ "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": null }, "error": "", "decorators": [ { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" } ] }, "childJobs": [ { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 } ], "retrySettings": { "ref": "wfEngineCommon#/definitions/retrySettings" } }, "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": "error", "claim_time": 75069184, "server_id": "95560d460d09c3466dc26ed61f84154516c44a2766dfcca3fdb65e3bc0765b4d", "app": { "id": "WorkFlowEngine", "version": "3.2.1" } }, "description": "Test Task", "app": "WorkflowBuilder", "canvasName": "taskName1", "canvasTab": "taskName1", "sla": 3600000, "view": "/workflow_builder/task/TestTask", "deprecated": false, "scheduled": false, "iterations": [ "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad" ], "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": null }, "error": "", "decorators": [ { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" } ] }, "childJobs": [ { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 } ], "retrySettings": { "ref": "wfEngineCommon#/definitions/retrySettings" } }, "error_handler": { "name": "TestTask", "summary": "Test Task", "description": "Test Task", "app": "WorkflowBuilder", "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": null }, "error": "", "decorators": [ { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" } ] }, "groups": [ "9e2dc43815acc7c23abf235a" ], "x": 0.36142061281337046, "y": 0.502092050209205, "type": "automated", "displayName": "WorkflowBuilder", "status": "complete", "deprecated": false, "scheduled": false, "retrySettings": { "state": [ "success", "failure", "success", "error", "failure" ], "autoRetry": false, "limit": 10, "delay": 2000, "count": 5 }, "canvasName": "taskName1", "canvasTab": "taskName1", "sla": 3600000, "view": "/workflow_builder/task/TestTask", "metrics": { "owner": "5a3496c64da02d9dfa0b2f91", "start_time": 1555430149763, "end_time": 1555430169683, "run_time": 75069184, "finish_state": "success", "claim_time": 75069184, "server_id": "95560d460d09c3466dc26ed61f84154516c44a2766dfcca3fdb65e3bc0765b4d", "app": { "id": "MOP", "version": "1.2.3" } }, "iterations": [ "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad" ], "childJobs": [ { "_id": "5cb7b531d06cceb89fd21b1c", "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": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad" ], "metrics": { "owner": "5a3496c64da02d9dfa0b2f91", "start_time": 1555430149763, "end_time": 1555430169683, "run_time": 75069184, "finish_state": "success", "claim_time": 75069184, "server_id": "95560d460d09c3466dc26ed61f84154516c44a2766dfcca3fdb65e3bc0765b4d", "app": { "id": "WorkFlowEngine", "version": "1.2.3" } }, "status": "canceled", "lastUpdatedVersion": "reprehenderit esse irure", "canvasVersion": 2, "decorators": [ { "type": "encryption", "pointer": "/variables/input" } ], "ancestors": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c" ], "preAutomationTime": 250000, "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 } ] } ], "skip": 0, "limit": 50, "total": 100 }
{ "title": "jobs", "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "jobsDocument" } }, "skip": { "$ref": "wfEngineCommon#/definitions/skip" }, "limit": { "$ref": "wfEngineCommon#/definitions/limit" }, "total": { "$ref": "wfEngineCommon#/definitions/total" } } }