Summary
Get a Job's Task
Description
Get the first Job's Task matching the query and return the data optionally modified by the filter.
Route
POST /workflow_engine/getTask
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| query |
object |
yes |
Query to retrieve a Task from a Job. |
| filter |
object |
yes |
Filter specifying which fields are returned. |
Copied to Clipboard
{
"query": null,
"filter": null
}
Copied to Clipboard
{
"type": "object",
"properties": {
"query": {
"description": "Query to retrieve a Task from a Job.",
"type": "object",
"properties": {},
"required": [
"query"
],
"additionalProperties": false
},
"filter": {
"description": "Filter specifying which fields are returned.",
"type": "object",
"properties": {},
"required": [
"filter"
],
"additionalProperties": false
}
},
"required": [
"query",
"filter"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| task_details |
object |
First Job's Task matching the query. |
Copied to Clipboard
{
"task_details": true
}
Copied to Clipboard
{
"description": "First Job's Task matching the query.",
"type": "object",
"properties": {
"task_details": true
},
"required": [
"task_details"
],
"additionalProperties": false
}
