Delivery API 2.0 Documents endpoint schemas
BaseDocument_System
Abstract document base class
Properties
| property | required | type | description | details | example |
|---|---|---|---|---|---|
| type | string | Field present in deeper nested structure or includes section | |||
| id | Y | string | The unique identifier for the document. | ||
| path | Y | string | The path to the document. | ||
| name | Y | string | The display name of the document. | ||
| locale | string | The locale of the document. | |||
| namespace | Y | string | The namespace of the document. | ||
| contentType | Y | string | The content type of the entry. | ||
| lastModified | Y | integer | The timestamp of the last modification of the document. |
| |
| links | Y | object |
GenericDocument_System
Properties
| property | required | type | description | details | example |
|---|---|---|---|---|---|
| fields | Y | object | Dynamic fields based on specific document type. |
Html_System
Rich Text Field
Properties
| property | required | type | description | details | example |
|---|---|---|---|---|---|
| value | string | Rich text with internal documents links in rewritten to <a data-api={api href} data-content-type={doc type}> and internal links to images / assets rewritten to a URL to fetch the resource | |||
| .meta | object | optional meta field which gets included when this object is used in 'Content Blocks' and which informs the consumer what kind of object this is in the array of content blocks |
GenericFieldGroup_System
Generic Field Group
Properties
| property | required | type | description | details | example |
|---|---|---|---|---|---|
| .meta | object | optional meta field which gets included when this object is used in 'Content Blocks' and which informs the consumer what kind of object this is in the array of content blocks |