abstract

big string

The abstract of the article.

author

string

The author of the article.

body

big string

The HTML text of the article.

creationDate

timestamp

Timestamp of when the article was created.

creationUser

string

Identifier of the user who created the article.

endDate

timestamp

Timestamp of when the article is no longer available, if a collection filter is implemented to use this property.

headline

string

The headline for the article. This property is intended for display on the storefront.

id

string

The repository ID of the article item.

lastModifiedDate

timestamp

Timestamp of the last time the article was modified.

lastModifiedUser

string

Identifier of the last user to modify the article.

mainImage

mediaContent item of mediaType Image

An image that is intended to be used as the main image when rendering an article on a page.

name

string

The item name displayed in the Business Control Center.

parentFolder

folder item

Folder containing the article item. Can be null (use of folders is optional).

postDate

timestamp

The timestamp when the article was posted. (Note that this is not necessarily the same as the startDate.) This property is intended for display on the storefront and to be used for sorting.

relatedArticles

list of article items

Other articles associated with the article.

relatedMedia

list of mediaContent items

mediaContent items associated with the article.

siteGroupIds

set

Derived property that indicates the ID of the site groups.

siteIds

set of site ID strings

In a multisite environment, the IDs of the sites the article is associated with. In a non-multisite environment, this property should be null.

startDate

timestamp

Timestamp of when the article becomes available, if a collection filter is implemented to use this property.

tags

set of tag items

The tag items associated with the article.

thumbnailImage

mediaContent item of mediaType Image

An image that is intended to be used as the thumbnail image when rendering an article on a page, such as in a spotlight. This image is also used as the thumbnail image for the article in the Business Control Center.

touchpointIds

set

Derived property that indicates the ID of the touchpoint item.

type

enum

Indicates the article type.

version

int

Integer that is incremented automatically each time the article is updated; used to prevent version conflict.