Document Creation Response Payload

object

a document payload

document_idstring(uuid)required

document id

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

revision_idstring(uuid)required

revision id

Example:ecfb698d-77a8-4ab5-91fa-45ee383b48ba

Example

Move document

object

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

Example

CreatedAt

string

An ISO-8601 timestamp representation of entity creation date.

Example

UpdatedAt

string

An ISO-8601 timestamp representation of entity update date.

Example

Error

object

standard error

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

typestringread-only

The error type.

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

Example