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 |
Whether pass on null is allowed. |
| query |
string |
yes |
Query body. |
| obj |
object |
yes |
- |
Copied to Clipboard
{
"job_id": "fugiat proident",
"pass_on_null": false,
"query": "enim Ut nostrud voluptate",
"obj": null
}
Copied to Clipboard
{
"type": "object",
"properties": {
"job_id": {
"description": "ID of the job to query.",
"type": "string"
},
"pass_on_null": {
"description": "Whether pass on null is allowed.",
"type": "boolean"
},
"query": {
"description": "Query body.",
"type": "string"
},
"obj": {
"type": "object",
"properties": {},
"required": [
"obj"
],
"additionalProperties": false
}
},
"required": [
"job_id",
"pass_on_null",
"query",
"obj"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| return_data |
* |
Returned data from the match query |
Copied to Clipboard
-61378034.10972751
Copied to Clipboard
{
"description": "Returned data from the match query",
"type": [
"string",
"integer",
"number",
"boolean",
"array",
"object",
"null"
]
}
