Template Item object representation

The templateitem object representation and fields are described below.

templateitem was introduced in API version V1

templateitem has not been marked for deprecation

Usages

Template Item

Description

Object representing a template content item associated with a content entity

Example create representation

{
  "entity" : {
    "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
    "url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
  },
  "name" : "subject",
  "sortOrder" : 0,
  "value" : "Welcome to Baack ${person.names[0].givenName}!"
}

Example response representation

{
  "urn" : "0cdc25e7-0a3a-4390-9cdb-667eaa099a9a",
  "entity" : {
    "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
    "url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
  },
  "url" : "/n/v1/templateitem/0cdc25e7-0a3a-4390-9cdb-667eaa099a9a",
  "name" : "subject",
  "sortOrder" : 0,
  "value" : "Welcome to Baack ${person.names[0].givenName}!"
}

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.
entity	entity	URN of the entity this template iem 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	String containing content template with template tags	The raw template without processing	Required on create. Maximum length: 4194304.