CreateDocumentPayload

object

a document payload

parent_document_idstring(uuid)

parent document id

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

slugstringrequired

document slug

Match pattern:^[\w\/-]+$

<= 512 characters

Example:path-for-seo

statusstring

document publish status. Default to published.

Allowed values:publishedunpublished

titlestringrequired

document title

Example:How to create a document in Konnect DocumentHub

raw_contentstring(byte)

Must be a base64 encoded string. Either raw_content or str_mdr_content are required.

Example:YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=

str_md_contentstring

Markdown content. Either raw_content or str_mdr_content are required.

Example:## My Markdown

metadataobject

Contains key value pairs information about entity’s metadata.

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

* Additional properties are allowed.
filenamestringrequired

name of the uploaded file

Example:my_doc.md

Example

UpdateDocumentPayload

object

a document payload

parent_document_idstring(uuid)

Parent document Id. If this value is explicitly set to null, the
document will be put as a top level document at the bottom of the tree.

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

slugstring

document slug

Match pattern:^[\w\/-]+$

<= 512 characters

Example:path-for-seo

statusstring

document publish status. Default to published.

Allowed values:publishedunpublished

titlestring

document title

Example:How to update a document in Konnect DocumentHub

raw_contentstring(byte)

base64 encoded string of the document content

Example:YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=

str_md_contentstring

markdown content

Example:## My Markdown

filenamestring

name of the uploaded file

Example:my_doc.md

metadataobject

Contains key value pairs information about entity’s metadata.

* Additional properties are allowed.
Example

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

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

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

StringFieldEqualsFilter

Filters on the given string field value by exact match.

One Of