Loading ...

REST API: Category Overview | Communifire Documentation

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

REST API: Category Overview

0 
 /5
0 (0votes)

Category Properties

The Category object performs division or classification of records in Communifire. It includes the Category ID that is used to refer to the particular category throughout the system. Each Category ID is unique and automatically generated. Categories are used to make sub-groups of entities such as Articles, Blogs, etc. 

Attribute Notes Data type
CategoryCount Number of subcategories under the category. int
CategoryDescription Brief description of the category. string
CategoryID ID value which uniquely identifies each category in the Communifire.
Generated automatically. This cannot be changed.		 int
CategoryName Name of the category. string
CategoryStub Unique string generated automatically by Communifire based on the category name provided by the user. This generated stub removes any special characters or spaces and replaces them with hyphens or ASCII symbols. string
ContentCount The number of content with the category. int
EntityType The type of entity referenced by the defined category. SystemEntityType
ParentCategoryID ID of the parent category of the category. int
ParentCategoryName Name of the parent category of the category. string
SpaceID The space ID if the category belongs to a space. int
SpaceName Name of the space. string
StatusID Unique ID to identify the status of category. A category can have “Draft” or “Active” status. Draft Category is not visible to the users. Accepted values are:
  • Deleted = 11
  • Draft = 2
  • Published = 1
 EntityStatus

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

 

Wiki Index

Pages

Intranet Software