Toggle menu

Content Property Reference

This articles lists all of the editable properties of the main content items in iCM. You'll also find the corresponding property name in the API (not everything returned by the API is included, see the iCM API for more details), a brief description, and links into the full documentation.

Articles

Editor FieldAPI Property NameTypeDescriptionDocumentation
ArchiveableArchiveableBooleanTrue if the article has an archive date setScheduling, Reviewing and Archiving Articles
Archive onArchiveDateDateTimeThe archive date, for example "2024-01-12T10:29:59Z"Scheduling, Reviewing and Archiving Articles
Archive toArchiveParentIDIntegerThe ID of the parent beneath which this article will be archivedScheduling, Reviewing and Archiving Articles
DisplayArticleDisplayBooleanIf true the article is visible on the siteScheduling, Reviewing and Archiving Articles
HeadingArticleHeadingStringThe article heading textHeadings, Links and Summaries
N/AArticleIDIntegerThe article ID, automatically generated when the article is created-
Intro textArticleIntroTextStringThe article introductory textHeadings, Links and Summaries
Alternate link textArticleLinkTextStringThe article's "alternate link" textHeadings, Links and Summaries
N/AArticlePathStringA list of article IDs, from the current to the site homepage. For example, if our current article has an ID of 21, its parent 9, its grand-parent (the site homepage) 1. the path would be "21,9,1,0"-
Summary textArticleSummaryStringThe article summary textHeadings, Links and Summaries
Body textArticleTextStringThe article body textWrite and Edit Article Content
N/AArticleTextAdditionalObjectAdditional text blocks, other than the body text. These are only present in some templates-
Boosted keywordsBoostedKeywordsStringA comma separated list of the article's boosted keywordsArticle Search Optimisation
Boost valueBoostValueIntegerThe search boost value, -10 to +10Article Search Optimisation
N/AChildArticleIDsStringA comma separated list of child article IDs-
CreatedCreationDateDateTimeThe date and time on which the article was created, for example "2018-01-12T10:29:59Z"Article Properties
Display endEndDateDateTimeThe date and time on which the article is scheduled to turn off, for example "2024-01-12T10:29:59Z"Scheduling, Reviewing and Archiving Articles
Friendly URLFriendlyURLStringThe article's friendly URLHeadings, Links and Summaries
Modified byLastModifiedByUserIDIntegerThe ID of the user who last modified the articleArticle Properties
ModifiedLastModifiedDateDateTimeThe date and time on which the article was last modified, for example "2022-01-12T10:29:59Z"Article Properties
Extra (tab)ObjExtensionDataObjectThe article extension data. Will only be returned if ExtensionDataReqd is set as true. Returns null if there is noneExtra Configuration and Related Content
OwnerOwnerIDIntegerThe UserID of the article ownerArticle Properties
Parent articleParentArticleIDIntegerThe ArticleID of the parent articleArticle Properties
Related content - ArticlesRelatedArticleIDsStringA comma separated list of ArticleIDs related to the current articleExtra Configuration and Related Content
Related content - FeaturesRelatedFeatureIDsStringA comma separated list of FeatureIDs related to the current articleExtra Configuration and Related Content
Related content - FormsRelatedFormIDsStringA comma separated list of FormIDs related to the current articleExtra Configuration and Related Content
Related content - ForumsRelatedForumIDsStringA comma separated list of ForumIDs related to the current articleExtra Configuration and Related Content
Related content - LinksRelatedLinkIDsStringA comma separated list of LinkIDs related to the current articleExtra Configuration and Related Content
Related content - MediaRelatedMediaIDsStringA comma separated list of MediaIDs related to the current articleExtra Configuration and Related Content
Related content - MetadataRelatedMetaDataIDsStringA comma separated list of MetadataIDs related to the current articleExtra Configuration and Related Content
Related content - PollsRelatedPollIDsStringA comma separated list of PollIDs related to the current articleExtra Configuration and Related Content
Update dueReviewableBooleanTrue if a ReviewDate or ReviewInterval have been setScheduling, Reviewing and Archiving Articles
Update due dateReviewDateDateTimeThe date and time on which the article update is due (whether explicitly set or calculated form the ReviewInterval), for example "2018-01-12T10:29:59Z"Scheduling, Reviewing and Archiving Articles
Update due everyReviewIntervalIntegerThe number of hours between reviewsScheduling, Reviewing and Archiving Articles
Site security (tab)SecureUserGroupIDsStringA comma separated list of user group IDs, or an empty string if the article is not securedSecuring Articles
Display startStartDateDateTimeThe date and time from which the article will display on the site, for example "2018-01-12T10:29:59Z"Scheduling, Reviewing and Archiving Articles
TemplateTemplateIDIntegerThe ID of the template the article is usingTemplates

 

Links

Editor FieldAPI Property NameTypeDescriptionDocumentation
Parent groupGroupIDIntegerThe ID of the group the link is inLink Groups
Parent groupGroupNameStringThe name of the group the link is inLink Groups
Link addressLinkAddressStringThe link URLCreate, Edit and Delete Links
Link descriptionLinkDescriptionStringThe link descriptionCreate, Edit and Delete Links
N/ALinkIDIntegerThe ID of the link, automatically generated when the link is created-
Link statusLinkStatusIntegerThe status of the linkCreate, Edit and Delete Links
Link textLinkTextStringThe display text for the linkCreate, Edit and Delete Links

 

Media Items 

Editor FieldAPI Property NameTypeDescriptionDocumentation
Article linkArticleIDIntegerThe ID of an article this media item will link to when output in the siteCreate, Edit and Delete Media Items
CreatedCreationDateDateTimeThe date and time this media item was created, for example "2018-01-12T10:29:59Z"Create, Edit and Delete Media Items
DescriptionDescriptionStringThe description of the media itemCreate, Edit and Delete Media Items
DisplayDisplayBooleanIf true the media item is visible on the siteCreate, Edit and Delete Media Items
Display endEndDateDateTimeThe date and time this media item will stop being displayed, for example "2018-01-12T10:29:59Z"Create, Edit and Delete Media Items
FilesFileArrayArrayThe components that make up this media item (ie different aspect ratios of an images, or a video file and transcript)Create, Edit and Delete Media Items
Parent groupGroupIDIntegerThe ID of the group this media item is inMedia Groups
Parent groupGroupNameStringThe name of the group this media item is inMedia Groups
ModifiedLastModifiedDateDateTimeThe date and time on which this media item was last modified, for example "2018-01-12T10:29:59Z"Create, Edit and Delete Media Items
External linkLinkIDIntegerThe ID of an external link this media item will link to when output in the siteCreate, Edit and Delete Media Items
N/AMediaIDIntegerThe ID of the media item, automatically generated when the media item is created-
N/AMediaPathArrayAn array of group IDs this item is in. 0 is the root media groupMedia Groups
Modified byModUserIDIntegerThe ID of the last user to edit this itemCreate, Edit and Delete Media Items
OwnerOwnerIDIntegerThe ID of the user who owns this media itemCreate, Edit and Delete Media Items
Related metadataRelatedMetaDataIDsStringA comma separated list of metadata IDs related to this media itemCreate, Edit and Delete Media Items
Update dueReviewableBooleanWhether this media item has a review date/interval or notCreate, Edit and Delete Media Items
Update due dateReviewDateDateTimeThe date and time on which the media item update is due (whether explicitly set or calculated form the ReviewInterval), for example "2018-01-12T10:29:59Z"Create, Edit and Delete Media Items
Update due everyReviewIntervalIntegerThe number of hours between reviewsCreate, Edit and Delete Media Items
Display startStartDateDateTimeThe date and time this media item will start being displayed, for example "2018-01-12T10:29:59Z"Create, Edit and Delete Media Items
Media titleTitleStringThe title of the media itemCreate, Edit and Delete Media Items
TypeTypeStringThe media item's type (ie a type definition such as image, PDF etc)Create, Edit and Delete Media Items

 

Metadata

This table describes metadata values, properties and descriptions.

Editor FieldAPI Property NameTypeDescriptionDocumentation
DescriptionDescription String The description of the metadata valueMetadata Values
Schema IDExternalSchemaID String The name of the external schema that this property value is mapped to (if defined)Metadata Values
Schema nameExternalSchemaName String The ID within the external schema that this property value is mapped to (if defined)Metadata Values
N/AGroupID IntegerThe metadata's property's parent group unique identifier-
Group nameGroupName String The metadata's property's parent group nameMetadata Groups
Search fieldGroupSearchField String Name of group search fieldMetadata Groups
Known terms (Synonyms)KnownTerms String A list of known terms (synonyms) for the property value (if defined)Metadata Values
Local terms (Synomyms)LocalTerms String A list of locally used termsMetadata Values
Property descriptionPropertyDescription String The description of the metadata's propertyMetadata Properties
N/APropertyID IntegerThe metadata's property unique identifier-
Property namePropertyName String The metadata's property nameMetadata Properties
Search fieldPropertySearchField String Name of property search fieldMetadata Properties
Related metadataRelatedMetadataOptionalIDs String  List of related metadata value IDsMetadata Values
NameValue String The value's nameMetadata Values
N/AValueID IntegerThe value's unique identifier, automatically generated when the value is created-

 

Last modified on 18 May 2023

Share this page

Facebook icon Twitter icon email icon

Print

print icon