Skip to main content
Version: 5.6

JSON Write Transfer Object

With the JSON transfer object as a simple data exchange format, you can modify or create JSON-formatted texts. Create a JSON transfer object within the connection as described. No plug-in configuration is necessary. You can project the transfer object directly within the connection as described. The JSON expression is "JPATH."

Here is an overview of the most important JPath syntax elements in comparison to the XPath elements:

XPathJSONPathDescription
/$The root object/element
.@Element in the current context
/.or []Specification for child elements
//..Recursive descent
**Placeholder. All objects/elements are selected regardless of their name.
[][]Subscript operator for element collections.
[]?()To execute a filter (script) expression.

JSON transfer object

After double-clicking on the transfer object, set the following properties:

PropertyDescription
Data fieldsData fields can be transferred from the defined JSON. The name is displayed on the TO as the parameter name and the expression specifies where in the JSON the value should be written. At runtime, the data transferred to the data fields is transferred to the JSON document, or the value defined in the JSON is overwritten with the value of the data field.
Data field placeholder

Data field placeholders are used in expressions. They are specified in curly brackets in the expressions, e.g.: {MyParameter}.
These can be used to write values dynamically to different locations in the JSON.

JSONSpecify the structure of the JSON document to be written here. You can enter the JSON syntax manually using the "Edit" button. Using the "Suggestions" button, you can evaluate transfers that have already been executed for this connection, examine them for JSON, and then adopt their syntax.
Fill values

Choose between the following modes:

  • Fill array values at all levels
  • Fill array values only within the same array
  • Duplicate document when an array is written to a data field

A tree structure is defined in the JSON Tree editor as follows, for example:

{ 
"key":"value",
"some":[
{"name":"one","value":1},
{"name":"two","value":2},
{"name":"three","value":3}
]
}