Summary
Get Jobs' Tasks
Description
Get Jobs' Tasks matching the query and return the data optionally modified by the filter.
Route
POST /workflow_engine/queryTasks
Roles
admin
apiread
Parameters
Details Example Schema
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
Copied to Clipboard
{
"query": {
"someFieldName": "Some Value to query the against the someFieldName property"
},
"filter": {
"name": 1
},
"options": {
"limit": 50,
"skip": 0
}
}
Copied to Clipboard
{
"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
}
Return
Details Example Schema
Name
Type
Description
task_details_array
array
All Jobs' Tasks matching the query.
Copied to Clipboard
[
{
"_id": "5cb7b531d06cceb89fd21b1c",
"job": {
"_id": "5cb7b531d06cceb89fd21b1c",
"task": "12ab",
"name": 18203999.926638216,
"description": 88418053,
"index": -90375025.05634904
},
"variables": {
"incoming": {
"inputVariable": "inputValue"
},
"outgoing": {
"outputVariable": null
},
"error": ""
},
"name": 60700156.332968056,
"summary": 55756957.82681671,
"displayName": 54094130.20567784,
"type": 46895236,
"x": false,
"y": "Duis tempor id",
"status": true
},
{
"_id": "5cb7b531d06cceb89fd21b1c",
"job": {
"_id": "4321abcdef694aa79dae47ad",
"task": "cd34",
"name": "ipsum",
"description": true,
"index": "ex dolore sit deserunt in"
},
"variables": {
"incoming": {
"inputVariable": "inputValue"
},
"outgoing": {
"outputVariable": null
},
"error": ""
},
"name": 24261899,
"summary": true,
"displayName": -88037019,
"type": -18252205,
"x": true,
"y": 14682600.448071301,
"status": -29462775
},
{
"_id": "4321abcdef694aa79dae47ad",
"job": {
"_id": "4321abcdef694aa79dae47ad",
"task": "cd34",
"name": "in ad",
"description": 72996350.69498631,
"index": -83039914.85633646
},
"variables": {
"incoming": {
"inputVariable": "inputValue"
},
"outgoing": {
"outputVariable": null
},
"error": ""
},
"name": 13542956,
"summary": true,
"displayName": 37991645.55519673,
"type": -60792360,
"x": -7395932.674063176,
"y": -76075602,
"status": 7985780
},
{
"_id": "5cb7b531d06cceb89fd21b1c",
"job": {
"_id": "5cb7b531d06cceb89fd21b1c",
"task": "12ab",
"name": -97443045,
"description": true,
"index": -55659170.169084504
},
"variables": {
"incoming": {
"inputVariable": "inputValue"
},
"outgoing": {
"outputVariable": null
},
"error": ""
},
"name": -49706755,
"summary": -31654830,
"displayName": -56604000,
"type": "ex veniam exercitation velit",
"x": false,
"y": 7169042.67291376,
"status": "est"
}
]
Copied to Clipboard
{
"type": "array",
"items": {
"$ref": "taskDocument"
}
}
