Summary
Find Job Documents
Description
Find job Documents based on a query and additional options.
Route
POST /workflow_engine/jobs/find
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| query | object | yes | A MongoDB query object. |
| options | object | yes | A MongoDB options object. |
{ "query": { "name": "abcd" }, "options": { "comment": "You can put a comment field on a query to make looking in the profiler logs simpler.", "maxTimeMS": 1000, "partial": false, "readPreference": "secondaryPreferred", "timeout": false, "limit": 50, "max": -13579601, "maxScan": 12840160, "min": 85685559, "skip": 0, "snapshot": true, "sort": [], "filter": { "name": 1 }, "returnKey": false, "explain": false } }
{ "type": "object", "properties": { "query": { "type": "object", "additionalProperties": { "type": "string" }, "examples": [ { "name": "abcd" } ] }, "options": { "$ref": "wfEngineCommon#/definitions/mongoCursorOptions" } }, "required": [ "query", "options" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| results | array | Resulting job Documents that matched query and options. |
[ { "_id": "4321abcdef694aa79dae47ad", "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": "5a3496c64da02d9dfa0b2f91", "start_time": 1555430149763, "end_time": 1555430169683, "run_time": 75069184, "finish_state": "error", "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": [ "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad" ], "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": null }, "error": "" }, "childJobs": [ { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_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": "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": "3.2.1" } }, "description": "Test Task", "app": "WorkflowBuilder", "canvasName": "taskName1", "canvasTab": "taskName1", "view": "/workflow_builder/task/TestTask", "deprecated": false, "scheduled": false, "iterations": [ "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "5cb7b531d06cceb89fd21b1c" ], "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": [ "5b663262d524dd8da310e992", "5db6b5871728ceb187acb972" ], "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": "voluptate laboris veniam cillum", "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" ], "childJobs": [ { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 } ] }, "57b": { "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": "anim voluptate aliquip", "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", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": null }, "error": "" }, "childJobs": [ { "_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", "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c" ], "metrics": { "owner": "Pronghorn", "start_time": 1555430149763, "end_time": 1555430169683, "run_time": 75069184, "finish_state": "incomplete", "server_id": "ac:de:48:00:11:22:3000", "app": { "id": "WorkflowBuilder", "version": "1.2.3" } }, "status": "canceled", "lastUpdatedVersion": "commodo quis eu incididunt", "canvasVersion": 1, "ancestors": [ "4321abcdef694aa79dae47ad" ], "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 } ] }, { "_id": "4321abcdef694aa79dae47ad", "name": "8917Test2", "tasks": { "9": { "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": { "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", "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad" ], "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": null }, "error": "" }, "childJobs": [ { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 } ] }, "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": "incomplete", "server_id": "ac:de:48:00:11:22:3000", "app": { "id": "WorkflowBuilder", "version": "3.2.1" } }, "description": "Test Task", "app": "WorkflowBuilder", "canvasName": "taskName1", "canvasTab": "taskName1", "view": "/workflow_builder/task/TestTask", "deprecated": false, "scheduled": false, "iterations": [ "4321abcdef694aa79dae47ad" ], "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": null }, "error": "" }, "childJobs": [ { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "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": "WorkFlowEngine", "version": "1.2.3" } }, "description": "Test Task", "app": "WorkflowBuilder", "canvasName": "taskName1", "canvasTab": "taskName1", "view": "/workflow_builder/task/TestTask", "deprecated": false, "scheduled": false, "iterations": [ "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad" ], "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": null }, "error": "" }, "childJobs": [ { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "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": [ "2cfe718c5699fba553ca3260", "1de410689ef6046c1f65ccff", "fb4f5f161142f7c11ba78251", "d0ce7c209be6ca2b992637bd" ], "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": "ut enim anim sunt ea", "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": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_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" ], "metrics": { "owner": "Pronghorn", "start_time": 1555430149763, "end_time": 1555430169683, "run_time": 75069184, "finish_state": "incomplete", "server_id": "ac:de:48:00:11:22:3000", "app": { "id": "MOP", "version": "3.2.1" } }, "status": "complete", "lastUpdatedVersion": "sed deserunt pariatur tempor", "canvasVersion": 2, "ancestors": [ "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 } ] }, { "_id": "4321abcdef694aa79dae47ad", "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": "5a3496c64da02d9dfa0b2f91", "start_time": 1555430149763, "end_time": 1555430169683, "run_time": 75069184, "finish_state": "error", "server_id": "ac:de:48:00:11:22:3000", "app": { "id": "WorkFlowEngine", "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" ], "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": "success", "server_id": "ac:de:48:00:11:22:3000", "app": { "id": "WorkFlowEngine", "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", "4321abcdef694aa79dae47ad" ], "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": null }, "error": "" }, "childJobs": [ { "_id": "4321abcdef694aa79dae47ad", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "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": [ "6df586f01be4e9facc01b246", "522455fad12e04212d197534", "0e4f59d8614389c78c2585fd" ], "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": "cillum et", "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", "5cb7b531d06cceb89fd21b1c", "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad" ], "childJobs": [ { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 }, { "_id": "5cb7b531d06cceb89fd21b1c", "name": "ChildJobRef", "iteration": 1 } ] }, "4c9": { "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": "incididunt enim qui dolore", "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": "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", "4321abcdef694aa79dae47ad" ], "metrics": { "owner": "5a3496c64da02d9dfa0b2f91", "start_time": 1555430149763, "end_time": 1555430169683, "run_time": 75069184, "finish_state": "complete", "server_id": "ac:de:48:00:11:22:3000", "app": { "id": "MOP", "version": "1.2.3" } }, "status": "running", "lastUpdatedVersion": "laborum sit minim", "canvasVersion": 1, "ancestors": [ "4321abcdef694aa79dae47ad", "4321abcdef694aa79dae47ad", "5cb7b531d06cceb89fd21b1c", "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 } ] } ]
{ "type": "array", "items": { "$ref": "jobsDocument" } }