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.

Description

The example below shows some object properties with descriptions.

id long Entity ID - cannot be null in PUT/PATCH methods ๐Ÿ“ถ EQUALS,ENUM ๐Ÿ”ฝ NONE

_cloudId integer Cloud ID ๐Ÿ”ฝ NONE

_eetSubjectId long? EET Subject ID ๐Ÿ“ถ EQUALS,ENUM ๐Ÿ”ฝ NONE

deleted boolean Entity deleted ๐Ÿ“ถ EQUALS,ENUM ๐Ÿ”ฝ NONE

externalId string? External ID ๐Ÿ“ถ EQUALS,ENUM ๐Ÿ”ฝ NONE

flags integer Entity flags - see Flags ๐Ÿ“ถ BITS ๐Ÿ”ฝ NONE

name string(180) Entity name ๐Ÿ“ถ EQUALS,STRING ๐Ÿ”ฝ BOTH

All internal IDs have an underscore prefix, f.e._cloudId.

All numeric properties are represented as string in JSON.

๐Ÿ“ถ filter groups allowed for a field ๐Ÿ”ฝ sort options available for a field

Validated properties

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.

โ€‹Data typesโ€‹

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)

โ€‹