Reference › Test Case Reference › Filter Descriptions › JSON Filters › JSON Path Filter

JSON Path Filter

The JSON Path filter lets you extract a JSON property value from a JSON object and save it to a property. To open its editor, click the filter.

Complete the following fields:

Filter in

Specifies the name of the property to filter for the step. If the property is not in the pull-down menu, you can enter it. The property must exist. You can edit this value for this filter.

JSON Path

Designates an expression that consists of a sequence of JSON properties in a JSON document. The JSON Path represents a path to a destination JSON property.

An array filter, denoted by a ?() expression, can be applied to an array as a select criteria to select certain array elements. For example, ?(@.age > 20) can be used to select array members whose age is greater than 20. Another example is ?(@.name in ('Mary', 'John')), which selects array members whose name is either Mary or John.

The following table lists supported filter operators that are available for JSON data types.

Save Value to Property

Designates the name of the property where the property value of the JSON path is saved.

Save Length to Property

Defines the name of the property where the number of components in the attribute value of the JSON path is saved. If the property value is an array, the number of components is the number of elements in the array. If the property value is a JSON object, the number of components is the number of properties in the JSON object. For simple data types such as String or Number, the number of components is 1.

Filter Run Results

Displays the property and values that result from running the filter.

Run Filter

To run and execute the filter, click Run Filter. The results appear in the Filter Run Results section.