The textitem object representation and fields are described below.
textitem was introduced in API version V1
textitem has not been marked for deprecation
A text content item associated with a content entity
{
"name" : "page_headline",
"sortOrder" : 0,
"value" : "Welcome to this page. This is a text item from an entity.",
"entity" : {
"urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
"url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
}
}{
"urn" : "c7fde7fa-e51c-4f63-a2a6-c790fa6457d6",
"name" : "page_headline",
"sortOrder" : 0,
"value" : "Welcome to this page",
"entity" : {
"urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
"url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
},
"url" : "/n/v1/textitem/c7fde7fa-e51c-4f63-a2a6-c790fa6457d6"
}| 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. 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 literal | A primitive string content item value | Required on create. Maximum length: 4194304. |
| entity | entity | The entity this text item is associated with. Note that this is required on creation so associate the item with the containing entity. If the entity already has a value for the given name and sort order the new item will be added as a new draft (next sibling) of the head version. If the field doesn't exist and the entity is already published then the new value will default to being the published version. | Required on create. |
| url | URL represented as a string | Endpoint URL for this text item | |