Documentation

Module 'JSONStructure'



Domain model

Back to top

Entities

Name Generalization Documentation
JSONArray JSONStructure.JSONValue Represents an array value. Can have multiple objects.
JSONBoolean JSONStructure.JSONValue Represents a boolean value.
JSONDecimal JSONStructure.JSONValue Represents a decimal value.
JSONInteger JSONStructure.JSONValue Represents an integer value.
JSONObject JSONStructure.JSONValue Represents an object value. Can have multiple properties.
JSONProperty Represents the left-hand side of a key/value pair.
JSONString JSONStructure.JSONValue Represents a string value.
JSONValue Base entity for all other value entities. Should not be used directly. Entities that derive from JSONValue can be used as the right-hand side of a key/value pair, i.e. as the value of a property.
Back to top

Entity 'JSONArray'

Represents an array value. Can have multiple objects.

Generalization

JSONStructure.JSONValue

Attributes
Entity 'JSONArray' has no attributes.
Associations
Entity 'JSONArray' does not own any associations.
Back to top

Entity 'JSONBoolean'

Represents a boolean value.

Generalization

JSONStructure.JSONValue

Attributes
Name Type Default value Documentation
Value Boolean false
Associations
Entity 'JSONBoolean' does not own any associations.
Back to top

Entity 'JSONDecimal'

Represents a decimal value.

Generalization

JSONStructure.JSONValue

Attributes
Name Type Default value Documentation
Value Decimal 0
Associations
Entity 'JSONDecimal' does not own any associations.
Back to top

Entity 'JSONInteger'

Represents an integer value.

Generalization

JSONStructure.JSONValue

Attributes
Name Type Default value Documentation
Value Integer 0
Associations
Entity 'JSONInteger' does not own any associations.
Back to top

Entity 'JSONObject'

Represents an object value. Can have multiple properties.

Generalization

JSONStructure.JSONValue

Attributes
Name Type Default value Documentation
Order Long 0 Internal representation of the order within an array. Should not be modified directly.
Associations
Name Connected to Multiplicity Documentation
array_items JSONStructure.JSONArray One-to-many
Back to top

Entity 'JSONProperty'

Represents the left-hand side of a key/value pair.

Attributes
Name Type Default value Documentation
Name String (200)
Associations
Name Connected to Multiplicity Documentation
object_properties JSONStructure.JSONObject One-to-many
property_value JSONStructure.JSONValue One-to-one
Back to top

Entity 'JSONString'

Represents a string value.

Generalization

JSONStructure.JSONValue

Attributes
Name Type Default value Documentation
Value String (unlimited)
Associations
Entity 'JSONString' does not own any associations.
Back to top

Entity 'JSONValue'

Base entity for all other value entities. Should not be used directly. Entities that derive from JSONValue can be used as the right-hand side of a key/value pair, i.e. as the value of a property.

Attributes
Entity 'JSONValue' has no attributes.
Associations
Name Connected to Multiplicity Documentation
property_value JSONStructure.JSONProperty One-to-one
Back to top


JavaActions

Name Return type Documentation
Deserialize JSONStructure.JSONValue Convert any JSON string into a generic JSON structure
ExportEntity JSONStructure.JSONObject
ExportList JSONStructure.JSONArray Export a list of any entity to a generic JSON array. There must be an export microflow defined for the entity that is being exported.
Serialize String Convert a generic JSON structure to its text representation. Normally, you would pass either a JSON Object entity or a JSON Array entity. However, it is possible to serialize other JSON values as well.
Back to top


JavaAction 'Deserialize'

Convert any JSON string into a generic JSON structure

Parameters
Name Type Category Description
JSON String JSON string that must be converted into a generic JSON structure
Return type

JSONStructure.JSONValue

Back to top


JavaAction 'ExportEntity'

Parameters
Name Type Category Description
Input Type Parameter "InputEntity" List of arbitrary entities to export to a generic JSON object
PrefixOverride String During export, the module looks for microflows that start with this prefix. Default: JSONExport_
Return type

JSONStructure.JSONObject

Back to top


JavaAction 'ExportList'

Export a list of any entity to a generic JSON array. There must be an export microflow defined for the entity that is being exported.

Parameters
Name Type Category Description
Input List of Type Parameter "InputEntity" List of arbitrary entities to export to a generic JSON array
PrefixOverride String During export, the module looks for microflows that start with this prefix. Default: JSONExport_
Return type

JSONStructure.JSONArray

Back to top


JavaAction 'Serialize'

Convert a generic JSON structure to its text representation. Normally, you would pass either a JSON Object entity or a JSON Array entity. However, it is possible to serialize other JSON values as well.

Parameters
Name Type Category Description
JSONValue JSONStructure.JSONValue Root of the JSON structure to be serialized
Pretty Boolean If false, export everything on one line. If true, add new lines and tabs.
SkipEmpty Boolean If false, include all properties in the output. If true, don't include any properties that have an empty value in the output.
Return type

String

Back to top


Microflows

Name Return type Documentation
AddArrayProperty JSONStructure.JSONProperty
AddBooleanProperty JSONStructure.JSONProperty
AddDecimalProperty JSONStructure.JSONProperty
AddIntegerProperty JSONStructure.JSONProperty
AddItem JSONStructure.JSONObject
AddObjectProperty JSONStructure.JSONProperty
AddProperty JSONStructure.JSONProperty
AddStringProperty JSONStructure.JSONProperty
CreateArray JSONStructure.JSONArray
CreateObject JSONStructure.JSONObject
SetArrayValue JSONStructure.JSONArray
SetBooleanValue JSONStructure.JSONBoolean
SetDecimalValue JSONStructure.JSONDecimal
SetIntegerValue JSONStructure.JSONInteger
SetObjectValue JSONStructure.JSONObject
SetStringvalue JSONStructure.JSONString
Back to top


Microflow 'AddArrayProperty'

Parameters
Name Type Documentation
JSONObject JSONStructure.JSONObject
Name String
Value JSONStructure.JSONArray
Return type

JSONStructure.JSONProperty

Back to top


Microflow 'AddBooleanProperty'

Parameters
Name Type Documentation
JSONObject JSONStructure.JSONObject
Name String
Value Boolean
Return type

JSONStructure.JSONProperty

Back to top


Microflow 'AddDecimalProperty'

Parameters
Name Type Documentation
JSONObject JSONStructure.JSONObject
Name String
Value Decimal
Return type

JSONStructure.JSONProperty

Back to top


Microflow 'AddIntegerProperty'

Parameters
Name Type Documentation
JSONObject JSONStructure.JSONObject
Name String
Value Integer
Return type

JSONStructure.JSONProperty

Back to top


Microflow 'AddItem'

Parameters
Name Type Documentation
JSONArray JSONStructure.JSONArray
JSONObject JSONStructure.JSONObject
Order Integer
Return type

JSONStructure.JSONObject

Back to top


Microflow 'AddObjectProperty'

Parameters
Name Type Documentation
JSONObject JSONStructure.JSONObject
Name String
Value JSONStructure.JSONObject
Return type

JSONStructure.JSONProperty

Back to top


Microflow 'AddProperty'

Parameters
Name Type Documentation
JSONObject JSONStructure.JSONObject
Name String
Return type

JSONStructure.JSONProperty

Back to top


Microflow 'AddStringProperty'

Parameters
Name Type Documentation
JSONObject JSONStructure.JSONObject
Name String
Value String
Return type

JSONStructure.JSONProperty

Back to top


Microflow 'CreateArray'

Parameters
This microflow has no parameters.
Return type

JSONStructure.JSONArray

Back to top


Microflow 'CreateObject'

Parameters
This microflow has no parameters.
Return type

JSONStructure.JSONObject

Back to top


Microflow 'SetArrayValue'

Parameters
Name Type Documentation
JSONProperty JSONStructure.JSONProperty
Value JSONStructure.JSONArray
Return type

JSONStructure.JSONArray

Back to top


Microflow 'SetBooleanValue'

Parameters
Name Type Documentation
JSONProperty JSONStructure.JSONProperty
Value Boolean
Return type

JSONStructure.JSONBoolean

Back to top


Microflow 'SetDecimalValue'

Parameters
Name Type Documentation
JSONProperty JSONStructure.JSONProperty
Value Decimal
Return type

JSONStructure.JSONDecimal

Back to top


Microflow 'SetIntegerValue'

Parameters
Name Type Documentation
JSONProperty JSONStructure.JSONProperty
Value Integer
Return type

JSONStructure.JSONInteger

Back to top


Microflow 'SetObjectValue'

Parameters
Name Type Documentation
JSONProperty JSONStructure.JSONProperty
Value JSONStructure.JSONObject
Return type

JSONStructure.JSONObject

Back to top


Microflow 'SetStringvalue'

Parameters
Name Type Documentation
JSONProperty JSONStructure.JSONProperty
Value String
Return type

JSONStructure.JSONString

Back to top