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 Field | API Property Name | Type | Description | Documentation |
|---|---|---|---|---|
| Archiveable | Archiveable | Boolean | True if the article has an archive date set | Scheduling, Reviewing and Archiving Articles |
| Archive on | ArchiveDate | DateTime | The archive date, for example "2024-01-12T10:29:59Z" | Scheduling, Reviewing and Archiving Articles |
| Archive to | ArchiveParentID | Integer | The ID of the parent beneath which this article will be archived | Scheduling, Reviewing and Archiving Articles |
| Display | ArticleDisplay | Boolean | If true the article is visible on the site | Scheduling, Reviewing and Archiving Articles |
| Heading | ArticleHeading | String | The article heading text | Headings, Links and Summaries |
| N/A | ArticleID | Integer | The article ID, automatically generated when the article is created | - |
| Intro text | ArticleIntroText | String | The article introductory text | Headings, Links and Summaries |
| Alternate link text | ArticleLinkText | String | The article's "alternate link" text | Headings, Links and Summaries |
| N/A | ArticlePath | String | A 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 text | ArticleSummary | String | The article summary text | Headings, Links and Summaries |
| Body text | ArticleText | String | The article body text | Write and Edit Article Content |
| N/A | ArticleTextAdditional | Object | Additional text blocks, other than the body text. These are only present in some templates | - |
| Boosted keywords | BoostedKeywords | String | A comma separated list of the article's boosted keywords | Article Search Optimisation |
| Boost value | BoostValue | Integer | The search boost value, -10 to +10 | Article Search Optimisation |
| N/A | ChildArticleIDs | String | A comma separated list of child article IDs | - |
| Created | CreationDate | DateTime | The date and time on which the article was created, for example "2018-01-12T10:29:59Z" | Article Properties |
| Display end | EndDate | DateTime | The 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 URL | FriendlyURL | String | The article's friendly URL | Headings, Links and Summaries |
| Modified by | LastModifiedByUserID | Integer | The ID of the user who last modified the article | Article Properties |
| Modified | LastModifiedDate | DateTime | The date and time on which the article was last modified, for example "2022-01-12T10:29:59Z" | Article Properties |
| Extra (tab) | ObjExtensionData | Object | The article extension data. Will only be returned if ExtensionDataReqd is set as true. Returns null if there is none | Extra Configuration and Related Content |
| Owner | OwnerID | Integer | The UserID of the article owner | Article Properties |
| Parent article | ParentArticleID | Integer | The ArticleID of the parent article | Article Properties |
| Related content - Articles | RelatedArticleIDs | String | A comma separated list of ArticleIDs related to the current article | Extra Configuration and Related Content |
| Related content - Features | RelatedFeatureIDs | String | A comma separated list of FeatureIDs related to the current article | Extra Configuration and Related Content |
| Related content - Forms | RelatedFormIDs | String | A comma separated list of FormIDs related to the current article | Extra Configuration and Related Content |
| Related content - Forums | RelatedForumIDs | String | A comma separated list of ForumIDs related to the current article | Extra Configuration and Related Content |
| Related content - Links | RelatedLinkIDs | String | A comma separated list of LinkIDs related to the current article | Extra Configuration and Related Content |
| Related content - Media | RelatedMediaIDs | String | A comma separated list of MediaIDs related to the current article | Extra Configuration and Related Content |
| Related content - Metadata | RelatedMetaDataIDs | String | A comma separated list of MetadataIDs related to the current article | Extra Configuration and Related Content |
| Related content - Polls | RelatedPollIDs | String | A comma separated list of PollIDs related to the current article | Extra Configuration and Related Content |
| Update due | Reviewable | Boolean | True if a ReviewDate or ReviewInterval have been set | Scheduling, Reviewing and Archiving Articles |
| Update due date | ReviewDate | DateTime | The 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 every | ReviewInterval | Integer | The number of hours between reviews | Scheduling, Reviewing and Archiving Articles |
| Site security (tab) | SecureUserGroupIDs | String | A comma separated list of user group IDs, or an empty string if the article is not secured | Securing Articles |
| Display start | StartDate | DateTime | The date and time from which the article will display on the site, for example "2018-01-12T10:29:59Z" | Scheduling, Reviewing and Archiving Articles |
| Template | TemplateID | Integer | The ID of the template the article is using | Templates |
Links
| Editor Field | API Property Name | Type | Description | Documentation |
|---|---|---|---|---|
| Parent group | GroupID | Integer | The ID of the group the link is in | Link Groups |
| Parent group | GroupName | String | The name of the group the link is in | Link Groups |
| Link address | LinkAddress | String | The link URL | Create, Edit and Delete Links |
| Link description | LinkDescription | String | The link description | Create, Edit and Delete Links |
| N/A | LinkID | Integer | The ID of the link, automatically generated when the link is created | - |
| Link status | LinkStatus | Integer | The status of the link | Create, Edit and Delete Links |
| Link text | LinkText | String | The display text for the link | Create, Edit and Delete Links |
Media Items
| Editor Field | API Property Name | Type | Description | Documentation |
|---|---|---|---|---|
| Article link | ArticleID | Integer | The ID of an article this media item will link to when output in the site | Create, Edit and Delete Media Items |
| Created | CreationDate | DateTime | The date and time this media item was created, for example "2018-01-12T10:29:59Z" | Create, Edit and Delete Media Items |
| Description | Description | String | The description of the media item | Create, Edit and Delete Media Items |
| Display | Display | Boolean | If true the media item is visible on the site | Create, Edit and Delete Media Items |
| Display end | EndDate | DateTime | The date and time this media item will stop being displayed, for example "2018-01-12T10:29:59Z" | Create, Edit and Delete Media Items |
| Files | FileArray | Array | The 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 group | GroupID | Integer | The ID of the group this media item is in | Media Groups |
| Parent group | GroupName | String | The name of the group this media item is in | Media Groups |
| Modified | LastModifiedDate | DateTime | The 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 link | LinkID | Integer | The ID of an external link this media item will link to when output in the site | Create, Edit and Delete Media Items |
| N/A | MediaID | Integer | The ID of the media item, automatically generated when the media item is created | - |
| N/A | MediaPath | Array | An array of group IDs this item is in. 0 is the root media group | Media Groups |
| Modified by | ModUserID | Integer | The ID of the last user to edit this item | Create, Edit and Delete Media Items |
| Owner | OwnerID | Integer | The ID of the user who owns this media item | Create, Edit and Delete Media Items |
| Related metadata | RelatedMetaDataIDs | String | A comma separated list of metadata IDs related to this media item | Create, Edit and Delete Media Items |
| Update due | Reviewable | Boolean | Whether this media item has a review date/interval or not | Create, Edit and Delete Media Items |
| Update due date | ReviewDate | DateTime | The 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 every | ReviewInterval | Integer | The number of hours between reviews | Create, Edit and Delete Media Items |
| Display start | StartDate | DateTime | The date and time this media item will start being displayed, for example "2018-01-12T10:29:59Z" | Create, Edit and Delete Media Items |
| Media title | Title | String | The title of the media item | Create, Edit and Delete Media Items |
| Type | Type | String | The 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 Field | API Property Name | Type | Description | Documentation |
|---|---|---|---|---|
| Description | Description | String | The description of the metadata value | Metadata Values |
| Schema ID | ExternalSchemaID | String | The name of the external schema that this property value is mapped to (if defined) | Metadata Values |
| Schema name | ExternalSchemaName | String | The ID within the external schema that this property value is mapped to (if defined) | Metadata Values |
| N/A | GroupID | Integer | The metadata's property's parent group unique identifier | - |
| Group name | GroupName | String | The metadata's property's parent group name | Metadata Groups |
| Search field | GroupSearchField | String | Name of group search field | Metadata 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 terms | Metadata Values |
| Property description | PropertyDescription | String | The description of the metadata's property | Metadata Properties |
| N/A | PropertyID | Integer | The metadata's property unique identifier | - |
| Property name | PropertyName | String | The metadata's property name | Metadata Properties |
| Search field | PropertySearchField | String | Name of property search field | Metadata Properties |
| Related metadata | RelatedMetadataOptionalIDs | String | List of related metadata value IDs | Metadata Values |
| Name | Value | String | The value's name | Metadata Values |
| N/A | ValueID | Integer | The value's unique identifier, automatically generated when the value is created | - |
Last modified on 18 May 2023
Share this page
