app-workflow_engine

On this page:

query

Summary

Query Data Using 'json-query' Format

Description

Query data using a dot/bracket notation string and a matching key/value pair.

Route

POST /workflow_engine/query

Roles

admin apiread

Parameters

DetailsExampleSchema
Name Type Required Description
job_id string yes ID of the job to query.
pass_on_null boolean yes Determines the query task results (return_data and transition) if the query fails. See Query Task Reference documentation for more info.
query string yes Query body.
obj object yes Data to query.

Return

DetailsExampleSchema
Name Type Description
return_data * Returned data from the match query