Corrigo: Model schemas
1 Corrigo schema with complete fields and constraints.
← Model operations · All schemas
Create model — 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 | |
allowAnonymousRequests | boolean | Optional | |
assetCategoryId | string | Optional | One of: Unknown, Regular, Building, Unit, Community, RoomArea, Floor, Utility, Equipment Format: int32 |
attributeDescriptors | JSON | Optional | |
attributeDescriptors (anyOf 1) | array | Alternative | |
attributeDescriptors (anyOf 1)[] | JSON | Each item | |
attributeDescriptors (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo LinkModelAndAttribute. |
attributeDescriptors (anyOf 1)[] (anyOf 2) | null | Alternative | |
attributeDescriptors (anyOf 2) | null | Alternative | |
chargeCode | JSON | Optional | |
chargeCode (anyOf 1) | object | Alternative | A Corrigo ChargeCodeLookup. |
chargeCode (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
displayAs | JSON | Optional | |
displayAs (anyOf 1) | string | Alternative | |
displayAs (anyOf 2) | null | Alternative | |
glAccount | JSON | Optional | |
glAccount (anyOf 1) | string | Alternative | |
glAccount (anyOf 2) | null | Alternative | |
instructions | JSON | Optional | |
instructions (anyOf 1) | string | Alternative | |
instructions (anyOf 2) | null | Alternative | |
number | JSON | Optional | |
number (anyOf 1) | string | Alternative | |
number (anyOf 2) | null | Alternative | |
parts | JSON | Optional | |
parts (anyOf 1) | array | Alternative | |
parts (anyOf 1)[] | JSON | Each item | |
parts (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo LinkProductAndQtyAttribute. |
parts (anyOf 1)[] (anyOf 2) | null | Alternative | |
parts (anyOf 2) | null | Alternative | |
public | boolean | Optional | |
subComponentIdx | string | Optional | |
tasks | JSON | Optional | |
tasks (anyOf 1) | array | Alternative | |
tasks (anyOf 1)[] | JSON | Each item | |
tasks (anyOf 1)[] (anyOf 1) | object | Alternative | A Corrigo Task. |
tasks (anyOf 1)[] (anyOf 2) | null | Alternative | |
tasks (anyOf 2) | null | Alternative |