Document
A Document model used for documents payloads.
Properties
| Property | Type | Format | Required | Description |
|---|---|---|---|---|
id |
string |
uuid |
true | Identifier of the document (revision id) |
parentId |
string |
uuid |
true | Identifier of the document parent folder |
revisionKey |
string |
uuid |
true | Identifier of the revisions (revision key) |
revisionNumber |
number |
int |
true | Number of the revision |
isPrivate |
boolean |
true | Flag which informs if document is uploaded to the private folder | |
title |
string |
true | Title of the document | |
comment |
string |
false | Comment to the document | |
authorId |
string |
uuid |
false | Identifier of the document's author |
Example:
{
"id": "1f2c07bc-a333-49a3-bb39-287f49d3b50b",
"parentId": "6d076738-53b1-4a31-9cd5-7c43d7180cd3",
"revisionKey": "80ee476b-3869-424c-bcfd-ab96924eb609",
"revisionNumber": 1,
"isPrivate": false,
"title": "Example document title",
"comment": null,
"authorId": "f8298546-fde8-4e49-a9ce-a88f6bc5faa6"
}