Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
idintegerOptionalFormat: int32
isNewbooleanOptionalRead only: true
limitMultipleEntitiesNumberBehaviourbooleanOptional
performDeletionbooleanOptional
propertiesJSONOptional
properties (anyOf 1)arrayAlternative
properties (anyOf 1)[]JSONEach item
properties (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo PropertyTreeNode.
properties (anyOf 1)[] (anyOf 2)nullAlternative
properties (anyOf 2)nullAlternative
concurrencyIdintegerOptionalFormat: int32
isRemovedbooleanOptional
actorTypeIdModelOptionalExpand Create actor — request body — body entity type Id
cpnRequestorIdintegerOptionalFormat: int32
lengthintegerOptionalFormat: int32
nameJSONOptional
name (anyOf 1)stringAlternative
name (anyOf 2)nullAlternative
optionsJSONOptional
options (anyOf 1)arrayAlternative
options (anyOf 1)[]JSONEach item
options (anyOf 1)[] (anyOf 1)objectAlternativeA Corrigo CustomFieldOption.
options (anyOf 1)[] (anyOf 2)nullAlternative
options (anyOf 2)nullAlternative
sharedByRequestorstringOptionalOne of: None, ReadOnly, ReadWrite
Format: int32
sharedWithProviderstringOptionalOne of: None, ReadOnly, ReadWrite
Format: int32
typestringOptionalOne 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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.