Page History

...

You can use JSON path expressions with following mediators:

Mediator Usage

As a log property:

Code Block

language	html/xml

<log>
    <property name="location" 
              expression="json-eval($.coordinates.location[0].name)"/>
</log>

Property

As a standalone property:

Code Block

language	html/xml

<property name="location" 
              expression="json-eval($.coordinates.location[0].name)"/>

PayloadFactory

As the payload arguments:

Code Block

language	html/xml

<payloadFactory media-type="json">
    <format>{"RESPONSE":"$1"}</format>
    <args>
        <arg evaluator="json" expression="$.coordinates.location[0].name"/>
    </args>
</payloadFactory>

IMPORTANT: You MUST omit the json-eval() method within the payload arguments to evaluate JSON paths within the PayloadFactory mediator. Instead, you MUST select the correct expression evaluator (xml or json) for a given argument.

Switch

As the switch source:

Code Block

language	html/xml

<switch source="json-eval($.coordinates.location[0].name)">

Filter

As the filter source:

Code Block

language	html/xml

<filter source="json-eval($.coordinates.location[0].name)" 
        regex="Eiffel.*">

JSON path syntax

Suppose we have the following payload:

...

The following table summarizes sample JSONPath expressions and their outputs:

Expression	Result
$.	{ "id":12345, "id_str":"12345", "array":[1, 2, [[],[{"inner_id":6789}]]], "name":null, "object":{}, "$schema_location":"unknown", "12X12":"image12x12.png"}
$.id	12345
$.name	null
$.object	{}
$.['$schema_location']	unknown
$.12X12	image12x12.png
$.array	[1, 2, [[],[{"inner_id":6789}]]]
$.array[2][1][0].inner_id	6789

You can learn more about JSONPath syntax here.

...

Following are the XML to JSON transformation parameters and their descriptions:

Parameter	Description	Default Value
`synapse.commons.json.preserve.namespace`	Preserves the namespace declarations in the JSON output in XML to JSON transformations.	`false`
`synapse.commons.json.buildValidNCNames`	Builds valid XML NCNames when building XML element names in XML to JSON transformations.	`false`
`synapse.commons.json.output.autoPrimitive`	Allows primitive types in the JSON output in XML to JSON transformations.	`true`
`synapse.commons.json.output.namespaceSepChar`	The namespace prefix separation character for the JSON output in XML to JSON transformations.	The default separation character is `-`
`synapse.commons.json.output.enableNSDeclarations`	Adds XML namespace declarations in the JSON output in XML to JSON transformations.	`false`
`synapse.commons.json.output.disableAutoPrimitive.regex`	Disables auto primitive conversion in XML to JSON transformations.	null
`synapse.commons.json.output.jsonoutAutoArray`	Sets the JSON output to an array element in XML to JSON transformations.	`true`
`synapse.commons.json.output.jsonoutMultiplePI`	Sets the JSON output to an xml multiple processing instruction in XML to JSON transformations.	`true`
`synapse.commons.json.output.xmloutAutoArray`	Sets the XML output to an array element in XML to JSON transformations.	`true`
`synapse.commons.json.output.xmloutMultiplePI`	Sets the XML output to an xml multiple processing instruction in XML to JSON transformations.	`false`

synapse.commons.json.output.emptyXmlElemToEmptyStr

Sets an empty element to an empty JSON string in XML to JSON transformations.

true

Anchor

	troubleshooting
	troubleshooting

...

The parameters available in this section are as follows.

Parameter Name	Description
Schema keys defined for Validate Mediator	This section is used to specify the key to access the main schema based on which validation is carried out, as well as to specify the JSON, which needs to be validated.
Source	The JSONPath expression to extract the JSON that needs to be validated. E.g: `json-eval($.msg)"`

Following example use the below sample schema StockQuoteSchema.json file. Add this sample schema file (i.e. StockQuoteSchema.json) to the following Registry path: conf:/schema/StockQuoteSchema.json. For instructions on adding the schema file to the Registry path, see Adding a Resource.

...

Versions Compared

Old Version 23

New Version Current

Key

JSON path syntax