The markdownitem object representation and fields are described below.
markdownitem was introduced in API version V1
markdownitem has not been marked for deprecation
A markdown item value associated with a particular entity
{
"name" : "body",
"sortOrder" : 0,
"value" : "# Headline\n***Welcome***",
"entity" : {
"urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
"url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
}
}{
"urn" : "33a3fba0-4542-4ef5-9c9c-118a29d6b8dd",
"name" : "body",
"sortOrder" : 0,
"value" : "# Headline\n***Welcome***",
"entity" : {
"urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
"url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
},
"url" : "/n/v1/markdownitem/33a3fba0-4542-4ef5-9c9c-118a29d6b8dd"
}| Name | Type | Description | Constraints |
|---|---|---|---|
| urn | String representation of a Unique Resource Name. Typically a UUID with 36 characters. | The URN of this markdown item | |
| name | Field name, typically used in content items. Typically use conventions around html ID expectations. | Name for the markdown field e.g. body | Required on create. Maximum length: 1024. |
| sortOrder | Signed int32 | Field sorting order for field ordering | Required on create. |
| value | String literal | A markdown string which will be transformed into HTML | Required on create. Maximum length: 4194304. |
| entity | String representation of a Unique Resource Name. Typically a UUID with 36 characters. | The entity this markdown 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 | |