Corrigo: Document schemas
1 Corrigo schema with complete fields and constraints.
← Document operations · All schemas
Create document — 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 |
actorId | integer | Optional | Format: int32 |
actorTypeId | Model | Optional | Expand Create actor — request body — body entity type Id |
blob | JSON | Optional | |
blob (anyOf 1) | object | Alternative | A Corrigo Blob. |
blob (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
docType | JSON | Optional | |
docType (anyOf 1) | object | Alternative | A Corrigo DocumentType. |
docType (anyOf 2) | null | Alternative | |
docUrl | JSON | Optional | |
docUrl (anyOf 1) | string | Alternative | |
docUrl (anyOf 2) | null | Alternative | |
endDate | JSON | Optional | |
endDate (anyOf 1) | string | Alternative | Format: date-time |
endDate (anyOf 2) | null | Alternative | |
extensionId | integer | Optional | Format: int32 |
isPublic | boolean | Optional | |
isShared | boolean | Optional | |
mimeType | JSON | Optional | |
mimeType (anyOf 1) | string | Alternative | |
mimeType (anyOf 2) | null | Alternative | |
startDate | string | Optional | Format: date-time |
storageTypeId | string | Optional | One of: Local, URL, Cloud, WonDocument, WonNote, CloudShared Format: int32 |
title | JSON | Optional | |
title (anyOf 1) | string | Alternative | |
title (anyOf 2) | null | Alternative | |
updatedBy | JSON | Optional | |
updatedBy (anyOf 1) | object | Alternative | A Corrigo Actor. |
updatedBy (anyOf 2) | null | Alternative | |
updatedDate | string | Optional | Format: date-time |
wonId | integer | Optional | Format: int32 |
wonMemberId | integer | Optional | Format: int32 |
Referenced models: Create actor — request body — body entity type Id