CSPro ⇄ JSON Conversions: Image Object

A CSPro Image object is represented as a JSON object with "metadata" and "content" properties. Based on JSON serialization options—defined as an application property or dynamically—the value of the logic object or dictionary item can be serialized either as a data URL or as a localhost URL.

When using Image.getJson on an Image specified as a dictionary item, additional properties, "item" and "occurrences", give information about the dictionary item's properties as well as details about the item's occurrences.

For example, serializing an Image dictionary item, ROOF_IMAGE, to JSON using the default way of representing the binary data as a localhost URL, may look like:

ROOF_IMAGE.getJson()	ROOF_IMAGE.getValueJson()
{ "name": "ROOF_IMAGE", "type": "Image", "item": { "name": "ROOF_IMAGE", "labels": [ { "text": "Roof Image" } ], "contentType": "Image", "start": 4, "length": 1 }, "occurrences": { "record": 1, "item": 1 }, "value": { "metadata": { "filename": "CTB_1758807115.jpg", "mime": "image/jpeg" }, "content": { "url": "http://localhost:50505/vf/3/CTB_1758807115.jpg" } } }	{ "metadata": { "filename": "CTB_1758807115.jpg", "mime": "image/jpeg" }, "content": { "url": "http://localhost:50505/vf/3/CTB_1758807115.jpg" } }

To modify an Image's value from JSON using Image.setValueFromJson, CSPro can parse binary data as a data URL or can read a file from the disk. An exception occurs if the value is not defined properly or if the data is not a valid image that CSPro can process. For more information, see details on how to specify binary data for JSON deserialization.