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.

put
http://documenthub.documenthub.svc.cluster.local:4400/v2/collections/{collectionId}/documents/{documentId}/move

Path Parameters

collectionIdstring(uuid)required

Targeted collection

Example:bb84c46a-432d-4314-81e4-478614a52dcb

documentIdstring(uuid)required

Targeted document

Example:bb84c46a-432d-4314-81e4-478614a52dcb

Body

application/json

move document

Move document

move document request payload

parent_document_idstring(uuid)

parent document id

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

indexinteger

index of the document in the parent document’s children

Example:1

Response

The document has been moved

put/collections/{collectionId}/documents/{documentId}/move

Body

{}
 

ListDocumentsTree

object
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

a document tree

Show Child Parameters
Example

ListDocuments

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

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

filenamestringrequired

the filename of the document

Example:myDocument.md

statusstringrequired

document publish status. Default to published.

Allowed values:publishedunpublished

metadataobjectrequired

Contains key value pairs information about entity’s metadata.

Example:{"owner":"John Appleseed"}

* Additional properties are allowed.
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

Document

object

a document

idstring(uuid)required

the id of the document

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

parent_document_idstring(uuid)

the id of the parent document

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

slugstringrequired

the slug of the document

Example:getting-started

statusstringrequired

document publish status. Default to published.

Allowed values:publishedunpublished

revisionobjectrequired

revision of a document

Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example