The JQ Query action parses a JSON string and populates the identified variables using JQ Library. JQ is a parser utility for JSON data, you can use it to slice, filter, map, and transform structured data. Read more about what you can do with JQ at https://stedolan.github.io/jq/.
Tip
The Decode JSON action is part of the Technology Preview Extension
This action is part of the Technology Preview Extension, which is also referred to as the sandbox package. For information on obtaining and installing the extension, see Technology Preview Extension.
Parameter descriptions
The action provides these parameters:
| Parameter | Description |
|---|---|
| JSON Template | Sample JSON string which contains same data structure as the expected JSON when the trigger action is executed. |
| Filter | JQ filter to run on the JSON string. |
| Output Type | Currently only Support Object. This indicates that the output of JQ Query will result in an Object. This is used to render the correct Output Variables. |
| Debug | When this is set to True, the raw result of the query will be returned in output variable “Raw String”. This is created for debug purpose. |
Input tab
The following describes the Input tab for
JSON Query:
| Parameter | Description |
|---|---|
| JSON | The source of the JSON string when the trigger action is executed. This can be a variable or be a constant string. |
Output tab
| Parameter | Description |
|---|---|
| Output Variables | Each output variable identified from running JQ filter on JSON Template will be added as a row, allowing the parsed member to be assigned to a variable. |
Supported Data Types
- String, Integer, Double, Boolean, Array of any of the primitive listed above.
- If an output value contains decimal, it is categorized as Double.
- Output of array will be identified by Output Variable with “ANY” datatype (see picture below)
