Loading ...

REST API: Content Object Overview | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Content Object Overview
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 20

REST API: Content Object Overview

0 
 /5
0 (0votes)

Content Properties

The content object is a basic record in the Communifire system. It includes the Content ID that is used to refer to a particular content (Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas) throughout the system. Each Content ID is unique and automatically generated. The Entity Type property is used to make reference to the particular type of content.

Attribute Description Data type
AuthorAvatarImageUrl URL of the author's profile image. string
AuthorDisplayName Author's display name. string
AuthorEmail Email ID of the author. string
AuthorFirstName Author's first name. string
AuthorID Author's unique ID. int
AuthorLastName Author's last name. string
AuthorProfileUrl URL of the author's profile. string
AuthorUserName Author's user name. string
CategoryID ID value which uniquely identifies each category in the Communifire.
Generated automatically. This cannot be changed.		 int
CategoryName Name of category. string
CategoryStub Unique string generated by Communifire System based on the category name provided by the user. This stub removes any special characters or spaces and replaces them with hyphens or ASCII symbols. string
CommentCount Number of comments made on content. int
ContentBody Body of the content. string
ContentID ID value which uniquely identifies each content in the Communifire.
Generated automatically. This cannot be changed.		 int
ContentMediaServerRootURL Root URL of the media server. string
ContentStageID Used in Ideas. ID value which uniquely identifies idea stages. int
ContentStageName Used in Ideas. Name of idea stages. string
ContentStub Unique string generated by Communifire System based on the content name provided by the user. This stub removes any special characters or spaces and replaces them with hyphens or ASCII symbols. string
ContentSummary Brief description of the content. string
ContentTitle Title of the content. string
ContentURL URL to directly browse to the content. string
ContentVersionID Current version ID of content. int
DateCreated Date of the content creation. datetime
DateCreatedString Date (string) of the content creation. string
DatePublished Date when the content was published. datetime
DatePublishedString Date (string) when the content was published. string
DateUpdated Date when the content was updated. datetime
DateUpdatedString Date (string) when the content was updated. string
EntityType Entity type of content. SystemEntityType
IsFeatured Check if the content is featured or not. bool
IsLatest Check if the content is recent or not. bool
MetaDescription Brief information about content that will be displayed in search engine's result page. string
MetaKeywords Keywords tell search engines the topic of the page. string
MetaTitle Title of content that will be displayed in search engine's result page. string
ParentContentID Parent content ID of content. int
Rating Rating of content. double
SpaceID Unique ID of space. int
SpaceName Name of space. string
SpaceURL URL of space. string
StatusID Unique ID to identify the status of content. Here are the values of EntityStatus parameter:
  • PendingWorkflow = 0
  • Published = 1
  • Draft = 2
  • Declined = 3
  • Updated = 4
  • Expired = 5
  • Spam = 6
  • All = 7
  • DelayedPublishing = 8
  • TemporarilySaved = 9
  • UnderProcessing = 10
  • Deleted = 11
 EntityStatus
TagsCSV Name of tags. string
TagsIDCSV ID value which uniquely identifies tags in the Communifire.
Generated automatically. This cannot be changed.		 string
UpdatedByUserDisplayName Display name of the user who updated the content. string
UpdatedByUserID ID of the user who updated the content. int
ViewCount Number of times the content has been viewed. int
WorkflowID ID of the active workflow for content. int

Please Note  Refer to REST API: Create Content for how to create content via the REST API.

Wiki Index

Pages

Intranet Software