Comment on page
Schema
Description of entities, request and response objects.
A schema describes Entity, Request, Response, etc objects. Specific properties data type, required fields, filter groups, sort options and describes special cases. Schema is split into two blocks - the first block describes individual fields and the second shows the JSON format.
The example below shows some object properties with descriptions.
id long
Entity ID - cannot be null in PUT/PATCH methods
📶 EQUALS,ENUM 🔽 NONEdeleted boolean
Entity deleted
📶 EQUALS,ENUM 🔽 NONEexternalId string?
External ID
📶 EQUALS,ENUM 🔽 NONEname string(180)
Entity name
📶 EQUALS,STRING 🔽 BOTHAll internal IDs have an underscore prefix, f.e.
_cloudId.All numeric properties are represented as string in JSON.
Properties of data types followed by question mark (?) are optional. All other properties are mandatory. In special cases there can be a note mark with a number.
Property data type | Descriptiion |
name string | NOT NULL |
externalId string? | OPTIONAL |
id long [1] | Special case with group 1 description below |
firstName string? [2] | Special case with group 2 description below |
lastName string? [2] | Special case with group 2 description below |
companyName string? [2] | Special case with group 2 description below |
Properties with [number] have special description below.
[1] ID cannot be null in PUT/PATCH methods
[2] One of properties firstName, lastName, companyName cannot be BLANK / EMPTY but other can be EMPTY.
Value | Description |
string(400) | String with maximum length of 400 |
string(200,250) | String length between 200 to 250 |
string[] | Array of strings |
string[1,100] | Array of strings with item count between 1 to 100 |
string[](1000) | Array of strings with maximum length of 1000 in joined string (with separators) |
Last modified 3yr ago