JSON Representation of Symbols Overview

Logic Functionality

CSPro symbols can be represented in JSON. Every symbol has metadata, and many symbol types have routines for representing their values in JSON. The following table describes ways to access a symbol's JSON representation or to modify the symbol based on a JSON representation of the value.

Function / Action	Description
Symbol.getJson	Returns a symbol's metadata and value.
Symbol.getValueJson	Returns a symbol's value.
Symbol.setValueFromJson	Modifies a symbol based on a JSON representation of the value.
Logic.getSymbol	Returns a symbol's metadata and value.
Logic.getSymbolMetadata	Returns a symbol's metadata.
Logic.getSymbolValue	Returns a symbol's value.
Logic.setSymbolValue	Modifies a symbol based on a JSON representation of the value.

JSON Representation of Symbols

The following table describes the value-related serialization routines available for CSPro objects and contains links to the description of the JSON representation for each object. The way that symbols are serialized can be modified at an application-level, or when calling a serialization routine.

Documentation about all JSON representations feature will come in a future release.

Object	Value -> JSON	JSON -> Value	Serialization
numeric	✔	✔	CSPro ⇄ JSON Conversions: Numeric Values
string, alpha	✔	✔	CSPro ⇄ JSON Conversions: String Values
Array	✔	✔	CSPro ⇄ JSON Conversions: Array Object
Audio	✔	✔	CSPro ⇄ JSON Conversions: Audio Object
Block
Dictionary	✔
Document	✔	✔	CSPro ⇄ JSON Conversions: Document Object
File	✔
Freq	✔
function
Geometry	✔	✔	CSPro ⇄ JSON Conversions: Geometry Object
HashMap	✔	✔	CSPro ⇄ JSON Conversions: HashMap Object
Image	✔	✔	CSPro ⇄ JSON Conversions: Image Object
Item
List	✔	✔	CSPro ⇄ JSON Conversions: List Object
Map
Pff
Record
Report	✔	✔	CSPro ⇄ JSON Conversions: Report Object
StringWriter	✔	✔	CSPro ⇄ JSON Conversions: StringWriter Object
SystemApp	✔	✔
ValueSet	✔	✔