Entity object representation

The entity object representation and fields are described below.

entity was introduced in API version V1

entity has not been marked for deprecation

Usages

Description

A content entity, similar to a page with a collection of content items of differing types

Example create representation

{
  "owner" : {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  },
  "status" : "DRAFT_UNPUBLISHED",
  "name" : "/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c/content/",
  "language" : "en-GB",
  "variant" : "",
  "publishTimestamp" : "2025-07-14T09:00:00",
  "updatedTimestamp" : "2025-07-14T09:00:00"
}

Example response representation

{
  "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
  "url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
  "owner" : {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  },
  "status" : "PUBLISHED",
  "name" : "/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c/content/",
  "language" : "en-GB",
  "variant" : "",
  "publishTimestamp" : "2025-07-14T09:00:00",
  "updatedTimestamp" : "2025-07-14T09:00:00",
  "texts" : [ {
    "urn" : "c7fde7fa-e51c-4f63-a2a6-c790fa6457d6",
    "name" : "page_headline",
    "sortOrder" : 0,
    "value" : "Welcome to Baack!",
    "url" : "/n/v1/textitem/c7fde7fa-e51c-4f63-a2a6-c790fa6457d6"
  } ],
  "doubles" : [ ],
  "dateTimes" : [ ],
  "booleans" : [ ],
  "images" : [ ],
  "templates" : [ ],
  "markdowns" : [ ],
  "latLongs" : [ ],
  "longs" : [ ],
  "money" : [ ]
}

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.	UUID for the entity	Required on create. Minimum length: 36. Maximum length: 36.
url	URL represented as a string	URL for accessing this entity
owner	Company	The company owner for the entity	Required on create.
status		Publication status used to manage publication lifecycle. Set to 'PUBLISH' (verb) to trigger publication of all draft items pending.	Required on create. Allowed values: DRAFT_UNPUBLISHED PUBLISH_PENDING PUBLISH PUBLISHED PUBLISHED_WITH_DRAFTS
name	A path string similar to UNIX path for absolute paths	name of the content entity	Required on create. Maximum length: 1024.
language	Language code typically expressed in ISO 639 codes used by browsers	ISO 639-1 code for entity language. See https://en.wikipedia.org/wiki/ISO_639-1 e.g. en_GB	Required on create. Maximum length: 16.
variant	String literal	The variant of the entity, typically a tag, used for creating variations of the content for experimentation	Maximum length: 128.
publishTimestamp	Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.	Timestamp the entity was published. Note unpublished entities are not visible (publish time in the past).
updatedTimestamp	Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.	Timestamp of the last update of the content entity.
texts	Text Item[]	Collection of text items associated with the entity	Ignored on update.
doubles	Double Item[]	Collection of double items associated with the entity	Ignored on update.
dateTimes	Date Time Item[]	Collection of date time items associated with the entity	Ignored on update.
booleans	Boolean Item[]	Collection of boolean items associated with the entity	Ignored on update.
images	Image Item[]	Collection of image items associated with the entity	Ignored on update.
templates	Template Item[]	Collection of template items associated with the entity	Ignored on update.
markdowns	Markdown Item[]	Collection of markdown items associated with the entity	Ignored on update.
latLongs	Latitude / Longitude item[]	Collection of latitude longitude itemsassociated with the entity	Ignored on update.
longs	Long item[]	Collection of long integer items	Ignored on update.
money	Money Item[]	Collection of money items	Ignored on update.