Skip to main content

Retrieve values from JSON

Retrieve values from a provided JSON. This page documents the inputs, outputs, and outcomes of the Retrieve values from JSON Wrk Action. For JSONPath syntax, JSONPath NG extensions, and worked examples, see Working with JSONPath.

Application

  • JSON

Inputs (what you have)

NameDescriptionData TypeRequired?Example
JSON TextText in JSON format that you are looking to retrieve values fromText (Long)Yes{"key":"value"}
JSON pathThe JSON path to the object or value in the text you would like to retrieve.Text (Long)Yes{"Field1":"$.key"}
Custom Outputs nameThe name of the Custom Output in which to add the JSON valueText (Short)YesField1
Format outputs as an array?Format outputs as an arrayTrue/FalseNoTrue

Note: the value of inputs can either be a set value in the configuration of the Wrk Action within the Wrkflow, or a variable from the Data Library section. These variables in the Data Library section are the outputs of previous Wrk Actions in the Wrkflow.

Outputs (what you get)

NameDescriptionData TypeRequired?Example
Custom OutputsA new field to add the value from the input JSON. This field name must match the value in New field nameText (Long)YesField1

Outcomes

NameDescription
SuccessThis status is selected if details are extracted from the JSON.
No resultThis status is selected in the event of the following scenarios:None of the provided Custom Outputs found keys in the provided JSON
UnsuccessfulThis status is selected in the event of the following scenarios:The input text is not in JSON formatting and could not be converted.