CreateCollectionPayload
objectpayload to create the document collection
UpdateCollectionPayload
objectpayload to update the document collection
CreateDocumentPayload
objecta document payload
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
document slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
document publish status. Default to published.
Allowed values:publishedunpublished
document title
Example:How to create a document in Konnect DocumentHub
Must be a base64 encoded string. Either raw_content or str_mdr_content are required.
Example:YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=
Markdown content. Either raw_content or str_mdr_content are required.
Example:## My Markdown
Contains key value pairs information about entity’s metadata.
Example:{"owner":"John Appleseed"}
name of the uploaded file
Example:my_doc.md
UpdateDocumentPayload
objecta document payload
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
document slug
Match pattern:^[\w\/-]+$
<= 512 characters
Example:path-for-seo
document publish status. Default to published.
Allowed values:publishedunpublished
document title
Example:How to update a document in Konnect DocumentHub
base64 encoded string of the document content
Example:YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=
markdown content
Example:## My Markdown
name of the uploaded file
Example:my_doc.md
Contains key value pairs information about entity’s metadata.
Document Creation Response Payload
objecta document payload
document id
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
revision id
Example:ecfb698d-77a8-4ab5-91fa-45ee383b48ba
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