JSONPath Expression

The condition informs the path that the integration flow should follow when the information described there appears in the body of the request/response payload of the step preceding Choice V2.

To define the condition, you must use a JSONPath expression.

NOTE

JSONPath is a query language for JSON that allows you to select and extract data from a JSON document. You use a JSONPath expression to traverse the path to an element or set of elements in the JSON structure.

In the image below, the condition described for WHEN indicates that if the "city" element equals "São Paulo", the flow should follow that path. If the information is different from this, the flow will follow another path defined in another WHEN condition or OTHERWISE.

Now imagine you have the response payload from a previous step with the following information:

Thus, since the payload has the city element information equal to São Paulo, the flow will follow the path indicated in the WHEN condition, as seen in the image.

JSONPath syntax rules

To better understand the composition of a condition, let's look at the main syntax rules for JSONPath expressions:

• The "$" symbol refers to the root object or element.
• The "@" symbol refers to the current object or element.
• The "." operator is used to denote a child element of the current element.
• "[ ]" is used to denote a child element of the current element (by name or index).
• The "*" operator is a wildcard character, returning all objects or elements regardless of their names.
• The "," operator is the union operator, which returns the union of indicated children or indexes.
• The ":" operator is the operator for selecting parts of arrays. Thus, it returns a sub-collection from a collection.
• "? ( )" is used to filter all items that meet a certain criterion.

Usage examples

Now see examples of expressions, based on the JSON structure below:

NOTE

Modified and expanded structure from Stefan Goessner.