JSON Item object representation

The jsonitem object representation and fields are described below.

jsonitem was introduced in API version V1

jsonitem has not been marked for deprecation

Endpoint usages

JSON Item

Description

Representation of a JSON content entity for arbitrary JSON values

Example create representation

{
  "name" : "page_headline",
  "sortOrder" : 0,
  "value" : {
    "a" : "B",
    "c" : 4,
    "e" : false
  },
  "entity" : {
    "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
    "url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
  }
}

Example response representation

{
  "urn" : "d7fde7fa-e51c-4f63-a2a6-c790fa6457d9",
  "name" : "props",
  "sortOrder" : 0,
  "value" : {
    "a" : "B",
    "c" : 4,
    "e" : false
  },
  "entity" : {
    "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
    "url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
  },
  "url" : "/n/v1/jsonitem/d7fde7fa-e51c-4f63-a2a6-c790fa6457d9"
}

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.		Minimum length: 36. Maximum length: 36.
name	Field name, typically used in content items. Typically use conventions around html ID expectations.	Name for the field e.g. metadata. Fields names can be arbitrary however we suggest using HTML ID friendly names	Required on create. Maximum length: 1024.
sortOrder	Signed int32	Json item sorting order for field ordering	Required on create.
value	An arbitrary JSON object which can be used to represent any valid json subject to serialisation limits	An arbitrary JSON object subject to serialisation size only	Required on create. Maximum length: 65535.
entity	Entity	The entity this json item is associated with.	Required on create.
url	URL represented as a string	Endpoint URL for this json item
isPublished	Boolean literal e.g. true	In the context of item history set to true for the live published version of the json item
createdTimestamp	Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.	The timestamp the json item was created in history view
history	Text Item History	The history of this text item