Version: 17.07
Supported Since: 17.07
JSON Feature provides a collection of API methods that can be used to process JSON related payloads.
convertToSOAP11 |
Parameters
This API will convert the provided JSON message payload into a SOAP11 message payload. |
convertToSOAP11 |
Parameters
This API will convert the provided JSON message payload into a SOAP11 message payload. |
convertToSOAP12 |
Parameters
This API will convert the provided JSON message payload into a SOAP12 message payload. |
convertToSOAP12 |
Parameters
This API will convert the provided JSON message payload into a SOAP12 message payload. |
convertToXML |
Parameters
This API will convert the provided JSON message payload into an XML message payload. |
convertToXML |
Parameters
This API will convert the provided JSON message payload into an XML message payload. |
setAsJSONPayload |
Parameters
This API will convert the current JSON message payload into a JSON format payload. |
getUntypedMap |
Parameters
Returns
This API will return the current JSON message payload as an untyped Map. |
getTypedObject |
Parameters
Returns
This API will return the current JSON message payload as a typed object of the specified class. |
addOrUpdateField |
Parameters
This API will add or update the location pointed by the |
setField |
Parameters
This API will set a new field to the location pointed by the |
renameField |
Parameters
This API will replace the old key name of the location pointed by the |
removeField |
Parameters
This API will remove the given key at the location pointed by the |
addElementToArray |
Parameters
This API will add a new value to the array specified by the key at the location pointed by the `path. |
removeArrayElement |
Parameters
This API will remove the value at the index from the array, specified by the key at the location pointed by the |
extractContent |
Parameters
Returns
This API will extract the content of the location pointed by the |
extractTypedContent |
Parameters
Returns
This API will extract the content of the location pointed by the |
getJSONObject |
Parameters
Returns
This API will convert the provided JSON string into a JSON object. |
validateJSONPath |
Parameters
Returns
This API will return whether the given |
JsonPath expressions always refer to a JSON structure in the same way as XPath expressions are used in combination
with an XML document. The "root member object" in JsonPath is always referred to as $
regardless of an object or an
array.
JsonPath expressions can use the dot–notation
$.store.book[0].title
or the bracket–notation
$['store']['book'][0]['title']
JsonPath should be expressed in bracket-notation, if field names included in the JsonPath contain space
characters. Example $['book store']
|
Operator |
Description |
|
The root element to query. All path expressions start with this |
|
The current node being processed by a filter predicate |
|
Wildcard. Available anywhere a name or numeric is required |
|
Deep scan. Available anywhere a name is required |
|
Dot-notated child |
|
Bracket-notated child or children |
|
Array index or indexes |
|
Array slice operator |
|
Filter expression. Expression must evaluate to a boolean value |
Functions can be invoked at the tail end of a path. The input to a function is the output of the path expression. The function output is dictated by the function itself.
Operator |
Description |
|
Provides the min value of an array of numbers |
|
Provides the max value of an array of numbers |
|
Provides the average value of an array of numbers |
|
Provides the standard deviation value of an array of numbers |
|
Provides the length of an array |
Filters are logical expressions used to filter arrays. A typical filter would be [?(@.age > 18)]
where @
represents
the current item which is being processed. More complex filters can be created with logical operators &&
and ||
.
String literals must be enclosed by single or double quotes ([?(@.color == 'blue')]
or [?(@.color == "blue")]
).
Operator |
Description |
|
left is equal to right (note that |
|
left is not equal to right |
|
left is less than right |
|
left is less or equal to right |
|
left is greater than right |
|
left is greater than or equal to right |
|
left matches regular expression |
|
left exists in right |
|
left does not exists in right |
|
left is a subset of right |
|
size of left (array or string) should match right |
|
left (array or string) should be empty |