Common ModelsContainers

The Container object

The Container object is used to represent a grouping of articles in the knowledge base. This can include Spaces, Folders, Databases, etc.

idstringOptionalformat: "uuid"
remote_idstring or nullOptional
The third-party API ID of the matching object.
created_atdatetimeOptional
The datetime that this object was created by Merge.
modified_atdatetimeOptional
The datetime that this object was modified by Merge.
namestring or nullOptional<=254 characters
Name of the container.
descriptionstring or nullOptional<=2000 characters
Description of the container.
statusenum or nullOptional

The container’s status.

  • DRAFT - DRAFT
  • PUBLISHED - PUBLISHED
  • ARCHIVED - ARCHIVED
  • TRASH - TRASH
Allowed values:
container_urlstring or nullOptional<=2000 characters
The URL to the webpage of the container.
typeenum or nullOptional

The container’s type.

  • FOLDER - FOLDER
  • SPACE - SPACE
  • COLLECTION - COLLECTION
  • SECTION - SECTION
  • CATEGORY - CATEGORY
  • DATABASE - DATABASE
visibilityenum or nullOptional

The container’s visibility.

  • PUBLIC - PUBLIC
  • INTERNAL - INTERNAL
  • RESTRICTED - RESTRICTED
Allowed values:
remote_created_atdatetime or nullOptional
When the third party's container was created.
remote_updated_atdatetime or nullOptional
When the third party's container was updated.
parent_articlestring or nullOptionalformat: "uuid"
The parent article a container is nested within.
parent_containerstring or nullOptionalformat: "uuid"
The parent container a container is nested within.
permissionslist of objectsOptional
remote_was_deletedbooleanOptional

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptional
remote_datalist of objects or nullOptional