Corrigo: Custom field descriptor schemas
1 Corrigo schema with complete fields and constraints.
← Custom field descriptor operations · All schemas
Create custom field descriptor — request body — body entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | integer | Optional | Format: int32 |
isNew | boolean | Optional | Read only: true |
limitMultipleEntitiesNumberBehaviour | boolean | Optional | |
performDeletion | boolean | Optional | |
properties | JSON | Optional | |
properties (anyOf 1) | array | Alternative | |
properties (anyOf 1)[] | JSON | Each item | |
properties (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo PropertyTreeNode. |
properties (anyOf 1)[] (anyOf 2) | null | Alternative | |
properties (anyOf 2) | null | Alternative | |
concurrencyId | integer | Optional | Format: int32 |
isRemoved | boolean | Optional | |
actorTypeId | Model | Optional | Expand Create actor — request body — body entity type Id |
cpnRequestorId | integer | Optional | Format: int32 |
length | integer | Optional | Format: int32 |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
options | JSON | Optional | |
options (anyOf 1) | array | Alternative | |
options (anyOf 1)[] | JSON | Each item | |
options (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo CustomFieldOption. |
options (anyOf 1)[] (anyOf 2) | null | Alternative | |
options (anyOf 2) | null | Alternative | |
sharedByRequestor | string | Optional | One of: None, ReadOnly, ReadWrite Format: int32 |
sharedWithProvider | string | Optional | One of: None, ReadOnly, ReadWrite Format: int32 |
type | string | Optional | One of: Unknown, String, Integer, Decimal, Money, Phone, Date, Time, Boolean, Url, Text, StringAutocomplete, BooleanWithNA Format: int32 |
Referenced models: Create actor — request body — body entity type Id