Summary
Get a brief about Task(s) for currently running Jobs
Description
Get brief information about task(s) from the tasks collection in mongoDB. This will return only tasks that are attached to a currently running Job
Route
POST /workflow_engine/queryTasksBrief
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.
Copied to Clipboard
{
"query": {
"someFieldName": "Some Value to query the against the someFieldName property"
}
}
Return
Details Example Schema
Name
Type
Description
task_details_array
array
Jobs' Tasks matching the query.
Copied to Clipboard
[
{
"_id": "8085260c-d951-4e5f-9d52-06d911a4eb38",
"name": "TestTask",
"summary": "Test Task",
"displayName": "WorkflowBuilder",
"type": "automated",
"x": 0.36142061281337046,
"y": 0.502092050209205,
"status": "paused",
"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": "incomplete",
"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"
},
"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": 2
},
"iterations": [
"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": "magna",
"start_time": 1555430149763,
"end_time": 1555430169683,
"run_time": 75069184,
"finish_state": "incomplete",
"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"
},
"error": ""
}
}
]
Copied to Clipboard
{
"title": "task_details_array",
"type": "array",
"items": {
"$ref": "taskDocument"
}
}
