Transform

Transform message payload, header, variable, uri, and telemetry

Table 1. Supported parameters
Parameter Required Data type Details
messageBody Yes object List of JSONata transforms to perform. The first transform's capture is optional. If not specified, the entire input is used as capture For all subsequent transform(s), capture is required.
variable Yes object List of JSONata transforms to perform. The first transform's capture is optional. If not specified, the entire input is used as capture For all subsequent transform(s), capture is required.
distributedVariable Yes object List of JSONata transforms to perform. The first transform's capture is optional. If not specified, the entire input is used as capture For all subsequent transform(s), capture is required.
messageHeader Yes object List of JSONata transforms to perform on headers
messageUriQuery Yes object List of JSONata Query transforms to perform on query parameter(s)
messageUriPath Yes object JSONata transform to perform on uri path. Only json string, boolean, and number are accepted as valid result of this transformation for Uri Path.nsformation for Uri Path.
telemetry Yes object List of JSONata transforms to perform. The first transform's capture is optional. If not specified, the entire input is used as capture For all subsequent transform(s), capture is required.
Table 2. Nested properties inside messageBody
Parameter Required Data type Details
messageName No string or null Name of the message to transform. Default is response.
jsonataTransforms Yes array Holds a JSONata expression as a string for dynamic data transformation, or null if no expression is provided.
Table 3. Nested properties inside jsonataTransforms
Parameter Required Data type Details
capture No string or null The JSONata expression that captures json context for transformation
transform Yes string The expression that defines how to transform the content
Table 4. Nested properties inside variable
Parameter Required Data type Details
name Yes string Name of the variable
jsonataTransforms No array Holds a JSONata expression as a string for dynamic data transformation, or null if no expression is provided.
Table 5. Nested properties inside distributedVariable
Parameter Required Data type Details
expire No integer or null Optional integer, specify the time to live in seconds of the variable. If not specified, the expiration of chosen variable will stay as is currently.
name Yes string Name of the distributed variable
jsonataTransforms No array Holds a JSONata expression as a string for dynamic data transformation, or null if no expression is provided.
Table 6. Nested properties inside messageHeader , messageUriQuery and messageUriPath
Parameter Required Data type Details
messageName No string or null Name of the message to transform. Default is response
jsonataTransforms No array Holds a JSONata expression as a string for dynamic data transformation, or null if no expression is provided.
Table 7. Nested properties inside telemetry
Parameter Required Data type Details
keys Yes object List of literal keys of telemetry attributes
span No object Name and type of telemetry span to transform. Defaults to root span.
jsonataTransforms No array Holds a JSONata expression as a string for dynamic data transformation, or null if no expression is provided.
Table 8. Nested properties inside keys
Parameter Required Data type Details
keyLiterals Yes array of string Specifies a list of literal key names as strings used for telemetry or configuration