Documents data
Fields:
| Field Name | Type | Required | Description |
|---|---|---|---|
| id | string, number | Yes | Unique document identifier. |
| title | string | Yes | Name of the document. |
| created | string | null | No | Date of creation of document. |
| parent_entity_id | string, number | null | No | Identifier of parent entity. |
| path | string, null | No | Path to content of the document. |
| sort_order | number | null | No | The positive numeric value which defines the sort order |
| type | string | null | No | Specifies the format of the document content file. Accepted values are 'html' and 'markdown'. |
Description of fields:
id:
A unique identifier for the document, which is used to map and track the document within our system.
title:
Full document name for visual representation.
created:
Null or Datetime of creation of the document.
parent_entity_id:
Unique identifier that specifies the parent element that contains the document (reference to the parent space or folder).
path:
Document body specified as the relative path to HTML or MD file. It's possible to create cross-links to documents and cards: for Markdown links have to be like /[.*?](((?:card|document)/[a-zA-Z0-9-]+))/, for HTML – /href="((?:card|document)/[a-zA-Z0-9-]+)"/, where [a-zA-Z0-9-]+ is document or card ID. Examples: [cardTitle](card/ca3d1d44-1b1b-4b1b-8b1b-ca3d1dca3d1dca), href="document/D0C1D222-1B1B-4B1B-8B1B-D0C1DD0C1DD0".
sort_order:
type:
Defines the format in which the document's content file is structured. The accepted formats are 'html' for HTML-formatted content and 'markdown' for content using Markdown syntax. If not explicitly provided, the system defaults to using the 'html' format.
JSON schema:
