Itential Docs & Guides | Drive Automation for Modern Networks

Name	Type	Required	Description
query	object	yes	An object of property names and values to use in the query against the tasks collection. The property name must exist in the tasks collection. There must be at least 1 field you query upon.
filter	object	yes	Filter specifying which fields are returned. The structure of each property must conform to 'fieldName': 1. Eg. name:1 will return the name field
options	object	yes	Skip and limit

{ "query": { "someFieldName": "Some Value to query the against the someFieldName property" }, "filter": { "name": 1 }, "options": { "limit": 50, "skip": 0 } }

{ "type": "object", "properties": { "query": { "$ref": "wfEngineCommon#/definitions/queryObjectFieldNames" }, "filter": { "$ref": "wfEngineCommon#/definitions/queryResultFieldFilter" }, "options": { "type": "object", "title": "Search Options", "properties": { "limit": { "allOf": [ { "$ref": "wfEngineCommon#/definitions/limit" }, { "maximum": 1000 } ] }, "skip": { "$ref": "wfEngineCommon#/definitions/skip" } } } }, "required": [ "query", "filter", "options" ], "additionalProperties": false }

Name	Type	Description
task_details_array	array	All Jobs' Tasks matching the query.

[ { "_id": "8085260c-d951-4e5f-9d52-06d911a4eb38", "name": "TestTask", "summary": "Test Task", "displayName": "WorkflowBuilder", "type": "automated", "x": 0.36142061281337046, "y": 0.502092050209205, "status": "running", "job": { "_id": "f80f8dc8b5a04a72bd8dad6c", "name": "SomeJobName", "description": "This Job is for doing XYZ when ABC occurs", "task": "4a89", "index": 0 }, "iterations": [ "8085260c-d951-4e5f-9d52-06d911a4eb38" ], "description": "Test Task", "app": "WorkflowBuilder", "view": "/workflow_builder/task/TestTask", "deprecated": false, "scheduled": false, "metrics": { "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" } }, "locked": false, "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": "outputValue" }, "translations": { "translationVariable": "translationValue" }, "error": "" } }, { "_id": "8085260c-d951-4e5f-9d52-06d911a4eb38", "name": "TestTask", "summary": "Test Task", "displayName": "WorkflowBuilder", "type": "automated", "x": 0.36142061281337046, "y": 0.502092050209205, "status": "complete", "job": { "_id": "f80f8dc8b5a04a72bd8dad6c", "name": "SomeJobName", "description": "This Job is for doing XYZ when ABC occurs", "task": "4a89", "index": 2 }, "iterations": [ "8085260c-d951-4e5f-9d52-06d911a4eb38", "8085260c-d951-4e5f-9d52-06d911a4eb38", "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": { "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" } }, "locked": false, "variables": { "incoming": { "inputVariable": "inputValue" }, "outgoing": { "outputVariable": "outputValue" }, "translations": { "translationVariable": "translationValue" }, "error": "" } }, { "_id": "8085260c-d951-4e5f-9d52-06d911a4eb38", "name": "TestTask", "summary": "Test Task", "displayName": "WorkflowBuilder", "type": "automated", "x": 0.36142061281337046, "y": 0.502092050209205, "status": "error", "job": { "_id": "f80f8dc8b5a04a72bd8dad6c", "name": "SomeJobName", "description": "This Job is for doing XYZ when ABC occurs", "task": "4a89", "index": 0 }, "iterations": [ "8085260c-d951-4e5f-9d52-06d911a4eb38" ], "description": "Test Task", "app": "WorkflowBuilder", "view": "/workflow_builder/task/TestTask", "deprecated": false, "scheduled": false, "metrics": { "owner": "commodo id minim", "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": "" } }, { "_id": "8085260c-d951-4e5f-9d52-06d911a4eb38", "name": "TestTask", "summary": "Test Task", "displayName": "WorkflowBuilder", "type": "automated", "x": 0.36142061281337046, "y": 0.502092050209205, "status": "primed", "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" ], "description": "Test Task", "app": "WorkflowBuilder", "view": "/workflow_builder/task/TestTask", "deprecated": false, "scheduled": false, "metrics": { "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": "" } }, { "_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": 2 }, "iterations": [ "8085260c-d951-4e5f-9d52-06d911a4eb38", "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": { "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": "" } } ]

{ "type": "array", "items": { "$ref": "taskDocument" } }

app-workflow_engine

On this page:

queryTasks

Summary

Description

Route

Roles

Parameters

Return