Summary
Search Tasks
Description
Search Tasks with Options
Route
POST /workflow_engine/tasks/search
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
filter | object | yes | Search Filter |
options | object | yes | expand, fields, query, local, limit, skip, sort |
{ "filter": { "someFieldName": "Some Value to query the against the someFieldName property" }, "options": { "expand": [ "owner", "owner" ], "fields": { "name": 1 }, "query": { "name": "abcd" }, "limit": 50, "local": true, "skip": 0, "sort": { "name": -1 } } }
{ "type": "object", "properties": { "filter": { "$ref": "wfEngineCommon#/definitions/queryObjectFieldNames" }, "options": { "$ref": "wfEngineCommon#/definitions/expandedSearchOptions" } }, "required": [ "filter", "options" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
tasks | object | Search Results |
{ "results": [ { "_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" ], "description": "Test Task", "app": "WorkflowBuilder", "view": "/workflow_builder/task/TestTask", "deprecated": false, "scheduled": false, "metrics": { "owner": "mollit", "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" ], "description": "Test Task", "app": "WorkflowBuilder", "view": "/workflow_builder/task/TestTask", "deprecated": false, "scheduled": false, "metrics": { "owner": "deserunt quis", "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": "active", "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": { "owner": "reprehenderit sit ullamco eu consectetur", "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": "running", "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": { "owner": "dolore in veniam velit", "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": "" } } ], "skip": 0, "limit": 50, "total": 100 }
{ "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "taskDocument" } }, "skip": { "$ref": "wfEngineCommon#/definitions/skip" }, "limit": { "$ref": "wfEngineCommon#/definitions/limit" }, "total": { "$ref": "wfEngineCommon#/definitions/total" } } }