Move a document
This api allows the user to move a document within the document tree using the
parameters parent_document_id and index. If parent_document_id is not
provided, the document will be placed at the top level of the document tree.
index represents a zero-indexed document order relative to its siblings under
the same parent. For example, if we want to put the document at top level in
first position we would send parent_document_id: null and index: 0. This api
also supports using a negative index to count backwards from the end of the
document list, which means you can put the document in last position by using
index: -1.
Path Parameters
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Targeted document
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Body
application/json
Body
move document
Move document
move document request payload
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
index of the document in the parent document’s children
Example:1
Response
Response
The document has been moved
Authentication
Path Parameters
Body
ListDocumentsTree
objectreturns the pagination information
Show Child Parameters
a document tree
Show Child Parameters
ListDocuments
objectreturns the pagination information
Show Child Parameters
Show Child Parameters
Document item
objectthe id of the document
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
the id of the parent document
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
the slug of the document
Example:getting-started
the title of the document
Example:Getting Started
the filename of the document
Example:myDocument.md
document publish status. Default to published.
Allowed values:publishedunpublished
Contains key value pairs information about entity’s metadata.
Example:{"owner":"John Appleseed"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Document
objecta document
the id of the document
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
the id of the parent document
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
the slug of the document
Example:getting-started
document publish status. Default to published.
Allowed values:publishedunpublished
revision of a document
Show Child Parameters
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z