ContentAsset document (Data API 23.2)
(supports custom properties)
Document representing a content asset.
Property | Type | Constraints | Description |
---|---|---|---|
classification_folder_id |
String | The ID of the classification folder. It is only part of the response, if the assignment from this content asset to the folder is marked as 'default'. The property is read-only. To set the classification folder just create/update an assignment between this content asset and a folder and mark it as 'default'. See details in /libraries/{library_id}/folder_assignments/{content_id}/{folder_id} resource. | |
classification_folder_link |
String | The link to the classification folder. It is only part of the response, if the assignment from this content asset to the folder is marked as 'default'. The property is read-only. To set the classification folder just create/update an assignment between this content asset and a folder and mark it as 'default'. See details in /libraries/{library_id}/folder_assignments/{content_id}/{folder_id} resource. | |
creation_date |
Date | Returns the value of attribute 'creationDate'. | |
description |
Localized<String> | The localized content asset description. | |
id |
String | maxLength=256, minLength=1 | The id of the content asset. |
last_modified |
Date | Returns the value of attribute 'lastModified'. | |
link |
String | The link to the content asset resource. | |
name |
Localized<String> | The localized content asset name. | |
online |
SiteSpecific<Boolean> | Is the asset online? | |
page_description |
Localized<String> | The localized content asset page description. | |
page_keywords |
Localized<String> | The localized content asset page keywords. | |
page_title |
Localized<String> | The localized content asset page title. | |
page_url |
Localized<String> | The localized content asset page url. | |
searchable |
SiteSpecific<Boolean> | Is the asset searchable? | |
site_map_change_frequency |
SiteSpecific<String> | The content assets change frequency needed for the sitemap creation (always, hourly, daily, weekly, monthly, yearly, never). | |
site_map_included |
SiteSpecific<Integer> | maxIntegerValue=1, minIntegerValue=0 | The status if the content asset is included into the sitemap (either 0 or 1). |
site_map_priority |
SiteSpecific<Decimal> | The content assets priority needed for the sitemap creation (0.0 for no priority defined). | |
template |
String | The rendering template. |
X
OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.