app-workflow_engine

On this page:

getTask

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 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

Return

DetailsExampleSchema
Name Type Description
task_details object First Job's Task matching the query.