Documentation Index

Fetch the complete documentation index at: https://docs.lobstersoftware.com/llms.txt

Use this file to discover all available pages before exploring further.

JSON data encoder

Prev Next

Summary

NOTE: This data encoder sends the object in JSON format to the profile's _data input.

Some Lobster Integration profiles expect JSON. For this case, choose the JSON data encoder. This reference describes its parameters for integration specialists and IT admins.

Purpose

The JSON data encoder converts a Lobster Data Platform object into JSON. The target profile receives the data at the _data input. In the Call profile behavior, you select the encoder using the value JSON.

The encoder can replace the Server data encoder. This applies if you add a clazz field with the qualified class name to the root node.

Parameters

Parameter

Type

Default value

Description

Class field name

Text

class

Name of the field that declares an object's class in the output format. If you leave the field empty, the encoder writes the class name under an empty string. Newly created JSON codecs use the default value clazz starting with version 4.9.5-LTS and 4.10.0.

Enforce native types

Option

Off

Enforces native JSON data types, for example Number for numbers and Array for lists. This option can lose type information.

Difference from other data encoders

The Server data encoder uses the internal Server XML format and keeps the data structure unchanged. The XML data encoder produces Client XML and is deprecated. The JSON data encoder produces JSON and is the recommended alternative to Client XML.

Counterpart: JSON data decoder

The JSON data decoder reads the profile's response as JSON. Together, the encoder and decoder form the outbound and return path of the data transfer.

See also