Corrigo: Procedure template step schemas
1 Corrigo schema with complete fields and constraints.
← Procedure template step operations · All schemas
Create procedure template step — 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 | |
attrDescriptor | JSON | Optional | |
attrDescriptor (anyOf 1) | object | Alternative | A Corrigo AttributeDescriptor. |
attrDescriptor (anyOf 2) | null | Alternative | |
conditionAttribute | JSON | Optional | |
conditionAttribute (anyOf 1) | object | Alternative | A Corrigo AttributeOption. |
conditionAttribute (anyOf 2) | null | Alternative | |
conditionCustomField | JSON | Optional | |
conditionCustomField (anyOf 1) | object | Alternative | A Corrigo CustomFieldOption. |
conditionCustomField (anyOf 2) | null | Alternative | |
conditionType | string | Optional | One of: Unknown, Regular, Parent, Conditional Format: int32 |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
fieldDescriptor | JSON | Optional | |
fieldDescriptor (anyOf 1) | object | Alternative | A Corrigo CustomFieldDescriptor. |
fieldDescriptor (anyOf 2) | null | Alternative | |
index | integer | Optional | Format: int32 |
instructions | JSON | Optional | |
instructions (anyOf 1) | string | Alternative | |
instructions (anyOf 2) | null | Alternative | |
isRequired | boolean | Optional | |
parentStepId | integer | Optional | Format: int32 |
procedureTemplateId | integer | Optional | Format: int32 |
typeId | string | Optional | One of: Unknown, Text, Field, Attribute, Document Format: int32 |
yIdx | integer | Optional | Format: int32 |
zIdx | integer | Optional | Format: int32 |