Core Concepts of Object Definitions

Each object is broken down into its properties. All objects are defined by the following metadata:

Property: The JSON object property name.

Version: The minimum version of the API the property is compatible with.

Type: The data type representation.

Read-Only: The property cannot be updated on an object. Most likely it is a derived value, there is a function to manipulate it or modification is not supported in the current API revision. Posted read-only values will be ignored by the API.

Required: The property is required when posting an update. Generally stated as "Yes" or "No". When "n/a" is specified, it means the property is read-only and may not be modified directly. May also indicate that it is required in only certain operations.

Description: The property description, formatting information and valid values.

Back To Top