JSON Extensibility Reference

From UNIFYConnect v6.0 onwards, extensibility configuration is stored in JSON format.

Value Types

Array

Represented as a JSON array, however does not support mix content types

[ "one", "two", "three" ]

Boolean

Represented as a JSON boolean value.

true

DateTime

Represented as a JSON object containing these properties.

Property	Value
$fmt	dateTime
$value	A JSON string containing an ISO 8601 format date time.

{ "$fmt": "dateTime", "$value": "2022-12-21T12:00:00.0000000" }

Enum

Represented as a JSON string. The string value must be the name of one of the enum values.

"DefaultCredentials"

Floating Point Number

Represented as a JSON decimal number.

1.345

GUID

Represented as a JSON object containing these properties.

Property	Value
$fmt	guid
$value	A JSON string containing an GUID

{ "$fmt": "guid", "$value": "411e8074-160f-4974-af88-a9be390794bc" }

Integer Number

Represented as a JSON whole number.

43

Null

Represented as a JSON null, or by omitting the property.

null

Object

Represented as a JSON object with a special $version property containing the schema version for that object. Each instance of a configuration object is versioned separately. It is recommended to not change these version numbers or the objects schema, instead let UNIFYConnect manage this; the latest object schema version will always be used when configuration is written.

{ "$version": "1.0", "name": "Example" }

Referenced Value

Represented as a JSON object with the $xref property containing an external configuration value store key. All value and type information is defined in the external store.

{ "$xref": "hostname" }

Secure String

Represented as a JSON object with the $secureValue property containing an encrypted value as a base64 encoded string.

{ "$secureValue": "YXNkZmxja2hqYXNkZGQ=" }

String

Represented as a JSON string.

"localhost"

TimeSpan

Represented as a JSON object containing these properties.

Property	Value
$fmt	timeSpan
$value	A JSON string containing time span.

{ "$fmt": "timeSpan", "$value": "1.10:20:30" }