Loading ...

REST API: Forum Overview | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Forums » REST API: Forum Overview
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 10

REST API: Forum Overview

0 
 /5
0 (0votes)

Forum Properties

The forum object is used to create forums in the Communifire system. It includes the Forum ID that is used to make reference to the particular forum throughout the system. Each Forum ID is unique and automatically generated by the Communifire system.

Attributes Notes Data type
DateCreated
 Date of forum creation. datetime
Description Brief description of the forum. string
ForumID ID value which uniquely identifies each forum in the Communifire. Generated automatically. This cannot be changed. int
ForumURL URL of the forum. string
GroupID ID of the group under which the forum is created. int
GroupName Name of the group under which the forum is created. string
GroupStub Unique string generated by Communifire System based on the group name provided by the user. This stub removes any special characters or spaces and replaces them with hyphens or ASCII symbols. string
LastPostID ID of the last post. int
LastPosted Date when the last forum was posted. datetime
LastTopicID ID of the last forum topic. int
LastUserID ID of user who last posted on the forum. int
MetaDescription
 Brief information about forum 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 forum that will be displayed in search engine's result page. string
Name Name of the forum. string
NumOfPosts Number of posts. int
NumOfTopics Number of topics. int
ParentID ID of the parent forum. int
SortOrder
 Order in which forums are to be sorted. int
SpaceID Unique ID of space. int
SpaceName Name of space. string 
StatusID  Unique ID to identify the status of forum. Accepted values are:
  • Not - Active = 0
  • Active = 1
  int
Stub Unique string generated by Communifire System based on the forum name provided by the user. This stub removes any special characters or spaces and replaces them with hyphens or ASCII symbols. string
UserID ID of the user who created the forum. int
WorkflowID ID of the active workflow for forum. int

Please Note  Refer to REST API: Create Forum for how to create new forum via the REST API.

Wiki Index

Pages

Intranet Software