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.

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.

Last updated