Version: 17.07
Supported Since: 17.07
A JSON Field Remover is a processing element which removes a field, specified by the key
at a given JSON path
,
from a message payload.
In order to use this processing element, you must first select the JSON Operations dependency from the processors list when you are creating an empty Ultra project. If you have already created a project, you can add this dependency via Component Registry. From Tools menu, select Ultra Studio → Component Registry and from the Processors list, select the JSON Operations dependency. |
Next |
The resulting message context will be sent to this outport after removing the specified field at the provided
|
On Exception |
The message context will be sent to this outport if any exception occurred while removing the specified field at the
provided |
JSON Path |
|
Current Key Name |
Name of the current key which is to be removed at the specified |
In the following use case, the requirement is to receive a message with JSON payload from an
HTTP NIO Ingress Connector,
remove the specified key
at a given JSON path
from the received message payload and deliver the message to a backend
service via an
HTTP NIO Egress Connector.
The challenge is to remove the specified key
at the given JSON path
from the JSON message payload.
In this flow a JSON Field Remover processing element is configured to remove the sample key postalCode
at the JSON path $.address
of the input JSON payload.
For the following sample input JSON payload, the field postalCode
will be removed from the address
.
{
"first-name": "John",
"last-name" : "Doe",
"age" : 24,
"address" : {
"streetAddress": "1st Cross Street",
"city" : "Colombo",
"postalCode" : "81000"
},
"telephone-numbers": [
{
"type" : "mobile",
"number": "074-234-567-890"
},
{
"type" : "land line",
"number": "011-234-567-890"
}
]
}
Final result will be as follows,
{
"first-name": "John",
"last-name" : "Doe",
"age" : 24,
"address" : {
"streetAddress": "1st Cross Street",
"city" : "Colombo"
},
"telephone-numbers": [
{
"type" : "mobile",
"number": "074-234-567-890"
},
{
"type" : "land line",
"number": "011-234-567-890"
}
]
}