PaginatedMeta

object

returns the pagination information

pageobjectrequired

Contains pagination query parameters and the total number of objects returned.

Show Child Parameters
Example

Document item

object
* Additional properties are NOT allowed.
idstring(uuid)required

the id of the document

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

parent_document_idstring(uuid)required

the id of the parent document

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

slugstringrequired

the slug of the document

Example:getting-started

titlestringrequired

the title of the document

Example:Getting Started

Example

ListDocumentsPortal

object
* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
Example

DocumentTree

object

a document tree

idstring(uuid)required

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

parent_document_idstring(uuid)

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

titlestringrequired

the title of the document

Example:Getting Started

slugstringrequired

the slug of the document

Example:getting-started

metaobjectrequired

the metadata of the document

Example:{"author":"Jane Doe","description":"This is a description","keywords":"hello, world"}

childrenarray[object]required

a document tree

Show Child Parameters
Example

ListDocumentsTree

object
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

a document tree

Show Child Parameters
Example