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.updateValueFromJson	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.updateSymbolValue	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 JSON representations feature will come in a future release. In the meantime you can see if the documentation is updated at:

https://www.csprousers.org/help/CSPro/symbols_json_representation.html

Object	Value -> JSON	JSON -> Value
numeric	✔	✔
string, alpha	✔	✔
Array	✔	✔
Audio	✔	✔
Block
Dictionary	✔
Document	✔	✔
File	✔
Freq	✔
function
Geometry	✔	✔
HashMap	✔	✔
Image	✔	✔
Item
List	✔	✔
Map
Pff
Record
Report
SystemApp	✔	✔
ValueSet	✔	✔