JSON Documentation

Version: 3.0.1

Retrieved: 2025-10-09 15:15:59

JSON

The module is used to shift between JSON => Objects and Objects => JSON. When JSON is sent in it can be represented by string/byte[].

This module is designed to be located in the middle of a flow.

Settings

Examples

Converting from JSON to Object

When converting from JSON the Source Property is mandatory to set. The data type of the JSON to convert can be string or byte[].

Input

If Source Property is json the expected input might be:

{ "json": "{\n \"name\": \"steve\",\n \"age\": 45\n} }"

Output

If Target Property is person the result of the conversion will be written to the property person on the output like:

    {
    "json":
        "{\n \"name\": \"steve\",\n \"age\": 45\n}",
    "person":
      { "name": "steve", "age": 45 }
    }

Note: if you leave Target Property empty (allowed when converting to object) you would get only the object as output: { "name": "steve", "age": 45 }

Converting from Object to JSON

When converting from Object the Source Property is NOT mandatory to set.

Input

If Source Property is person the expected input might be:

{"person": {'name':'steve', 'age':45} }

Output

When converting to JSON the Target Property is mandatory to set. If Target Property is person the result of the conversion will be written to the property person on the output like:

    {
    "json":
        "{\n \"name\": \"steve\",\n \"age\": 45\n}",
    "person":
      { "name": "steve", "age": 45 }
    }

Note: if you would use the same Target Property as Source Property you will overwrite the Source with the Target. So if you use json as both source and target you will get: { "json": { "name": "steve", "age": 45 } }