Image Item object representation

The imageitem object representation and fields are described below.

imageitem was introduced in API version V1

imageitem has not been marked for deprecation

Endpoint usages

Description

Object representing an image resource

Example create representation

{
  "name" : "heading_background",
  "sortOrder" : 0,
  "altText" : "Description of the image",
  "entity" : {
    "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
    "url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
  },
  "isPublished" : false
}

Example response representation

{
  "urn" : "b62ebbea-fdc1-4926-917a-ffb0848fd239",
  "url" : "/n/v1/imageitem/b62ebbea-fdc1-4926-917a-ffb0848fd239",
  "name" : "heading_background",
  "sortOrder" : 0,
  "altText" : "Description of the image",
  "src" : "https://example.com/url/will/be/set/when/asset/uploaded.jpg",
  "entity" : {
    "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
    "url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
  },
  "isPublished" : false
}

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.
url	URL represented as a string	Url of the image item representation
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.
altText	String literal	Alt[ternative] text for image	Maximum length: 1024.
src	URL represented as a string	URL for the image for the default size	Maximum length: 2048.
largeSrc	URL represented as a string	URL for the image for the large size	Maximum length: 2048.
mediumSrc	URL represented as a string	URL for the image for the medium size	Maximum length: 2048.
entity	Entity	URN of the entity owning this image	Required on create.
isPublished	Boolean literal e.g. true	Set in the context of an image item history to indicate which item is published
createdTimestamp	Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.	The timestamp the image item was created in history view
history	Image item history	The history for this image item