Document

Schemas

1 of 46 in this chapter 1 min read

 
{
  "id": 123,
  "name": "My topic",
  "uuid": "UUID-1234-5678",
  "type": "document",
  "creator": "2",
  "owner": "2",
  "author": "2",
  "created_at": 1603622378,
  "modified_at": 1603622378,
  "checkout": "false",
  "checkout_user": "2",
  "parent_resource": 456,
  "taxonomies": [
    {
      "id": 603,
      "title": "My taxonomy",
      "color": 3
    }
  ],
  "content": "<?xml>...",
  "languages": [
    "en",
    "jp",
    "sv"
  ],
  "custom_attributes": [
    {
      "name": "My custom attribute name",
      "value": "My attribute value"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	The ID of the document.
name	string	false	none	The name of the document.
uuid	string	false	none	The UUID of the document
type	string	false	none	The resource type.
creator	integer	false	none	The ID of the user that created the document.
owner	integer	false	none	The ID of the user that owns the document.
author	integer	false	none	The ID of the user that created the document.
created_at	integer	false	none	The document creation time (as a unix timestamp).
modified_at	integer	false	none	The document modification time (as a unix timestamp).
checkout	boolean	false	none	The checkout status of the document.
checkout_user	integer	false	none	User that has checked out document
parent_resource	integer	false	none	The ID of the document’s parent resource.
taxonomies	[[???schemataxonomy???]]	false	none	The document’s taxonomies.
content	string	false	none	Document XML content. Only returned when requesting a single document.
languages	[string]	false	none	A list of all the documents translations.
custom_attributes	[[???schemacustomattribute???]]	false	none	A list of custom attributes on the document.