Comment on page
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.
idlong Entity ID - cannot be null in PUT/PATCH methods 📶
deletedboolean Entity deleted 📶
externalIdstring? External ID 📶
namestring(180) Entity name 📶
All internal IDs have an underscore prefix, f.e.
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.
Properties with [number] have special description below.
 ID cannot be null in PUT/PATCH methods  One of properties firstName, lastName, companyName cannot be BLANK / EMPTY but other can be EMPTY.