Syntax
set aString = anObject.classToJSON()
set aString = anObject.classToJSON(options)
Semantics

The operation classToJSON() takes any object (anObject) or array of objects and tries to map it to a JSON string aString. If this is not possible, an error is raised.
JSON types and xUML types are mapped as listed on JSON Type Mapping.

classToJSON() does not support cyclic structures. When a cyclic structure is detected during serializing the given object, an exception will be thrown.

SubstitutablesanObjectAny object. 
aStringTarget JSON document as String.
options

The optional parameter is an object of type ComposerOptions.

Its attribute is:

AttributeTypeDescriptionAllowed Values
keepNullsBooleanWhen keepNulls is true, attributes of anObject with NULL values will be rendered to the JSON object, otherwise they will be left out completely (see also chapter NULL Values). The default behavior of classToJson() (i.e. when called without options) is equivalent to keepNulls=false.trueRender NULL attributes to the JSON object.
falseLeave out NULL attributes (default).
compactBooleanWhen compact is true, the JSON composer will generate compact JSON, otherwise it will generate pretty JSON. The default behavior of classToJson() (i.e. when called without options) is equivalent to compact=false.trueGenerate compact JSON.
falseGenerate pretty JSON (default).
writeTypeDiscriminatorBoolean

Use writeTypeDiscriminator to suppress the generation of xUML type properties ("e2e:type") to the generated JSON. If this option is true, the Runtime will write the original xUML type to the generated JSON in form of "e2e:type": "<name of the original xUML type>" if the type being serialized does not match the expected metadata. This is necessary if you want to convert the generated JSON back to an xUML class using jsonToClass().

Runtime versions before 2021.6 will ignore the value.

trueWrite xUML type discriminator (default).
falseDo not write xUML type discriminator.
Examples
set addressAsJSONDocument = myAddress.classToJSON();

JSONAdapter_Example

Click the icon to download a simple example model that shows the usage of the JSON adapter (classToJSON) in Scheer PAS Designer.

JSONAdapter_Example

Click the icon to download a simple example model that shows the usage of the JSON adapter (classToJSON) in Scheer PAS Designer.

Related Pages:

  • No labels