Boolean Item object representation

The booleanitem object representation and fields are described below.

booleanitem was introduced in API version V1

booleanitem has not been marked for deprecation

Endpoint usages

Boolean Item

Description

A boolean content item associatedwith a content entity

Example create representation

{
  "entity" : {
    "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
  },
  "name" : "is_it_safe",
  "sortOrder" : 0,
  "value" : false
}

Example response representation

{
  "urn" : "8a1b6dfc-c255-4245-80cc-ebecd227c033",
  "entity" : {
    "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
    "url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
  },
  "url" : "/n/v1/booleanitem/8a1b6dfc-c255-4245-80cc-ebecd227c033",
  "name" : "is_it_safe",
  "sortOrder" : 0,
  "value" : false
}

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.	The URN of the boolean item in the context of an entity	Minimum length: 36. Maximum length: 36.
entity	Entity	The URN of the entity this boolean item value is associated with	Required on create.
url	URL represented as a string
name	Field name, typically used in content items. Typically use conventions around html ID expectations.	Name for the field e.g. meta_title. Fields can be arbitrary. Suggest using JS like field names	Required on create. Maximum length: 1024.
sortOrder	Signed int32	Field sorting order for field ordering	Required on create.
value	Boolean literal e.g. true	A boolean (truthy) content item	Required on create.
isPublished	Boolean literal e.g. true	A boolean indicating if this boolean content value item is published
createdTimestamp	Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.	The timestamp the boolean item was created in history view
history	Boolean item history	History accessor for the boolean item history