Loading ...

REST API: Create Content | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Create Content
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 72

REST API: Create Content

0 
 /5
0 (0votes)

Create Content

POST /api/content

Create a piece of content. List of supported entities: Articles, Blogs, CMS Pages, Wikis, Albums, Ideas, Forums, Forum Groups, Forum Topics, Forum Posts. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
POST
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
Content JSON Used in the request body This is JSON that represents a content object that you're creating. This should be of the format seen below in the sample given. The required values in this JSON are given below.
EntityType Used in the request body Entity Type of the entity. Here are the values of EntityType parameter:
  • Forum = 1
  • Forum Group = 2
  • Article = 3
  • Blog = 4
  • Wiki = 9
  • CMSPage = 12
  • Album = 18
  • Idea = 44
  • ForumPost = 54
  • ForumTopic = 55
CategoryID Used in the request body Category ID of the entity. Required parameter for following entities:
  • Article
  • Blog
  • CMSPage
  • Idea
Not required for following entities:
  • Album
  • Wiki
  • Forum
  • ForumGroup
  • ForumTopic
  • ForumPost
SpaceID Used in the request body Unique ID of the space. Space ID should be 0 for Top Level Community. Required parameter for every entity.
ContentTitle Used in the request body Title of the content. Required parameter for every entity.
ContentBody Used in the request body Content Body of the entity. Required parameter for following entities:
  • Article
  • Blog
  • CMSPage
  • Album
  • Wiki
  • Idea
  • Forum
  • ForumTopic
  • ForumPost
Not required for following entities:
  • ForumGroup
ContentSummary Used in the request body Content Summary of the entity. Required parameter for following entities:
  • Article
  • Blog
Not required for following entities:
  • Forum
  • ForumGroup
  • ForumTopic
  • ForumPost
  • CMSPage
  • Album
  • Wiki
  • Idea
ParentContentID Used in the request body Parent Content ID of the entity. Required parameter for following entities:
  • Forum
  • Forum Topic
  • Forum Post
Optional parameter for following entities:
  • Wiki - To specify the parent wiki
  • CMSPage
Not required parameter for following entities:
  • Article
  • Blog
  • Album
  • Idea
  • ForumGroup
ContentStageID Used in the request body Used in Ideas to specify the Idea stage.
MetaTitle, MetaDescription, MetaKeywords Used in the request body Meta title, Description and Keywords of the entity. Required parameter for following entity(ies):
  • ForumGroup
Optional parameter for following entities:
  • Article
  • Blog
  • CMSPage
  • Idea
  • Album
  • Wiki
Not required for following entities:
  • Issue
  • Forum
  • ForumTopic
  • ForumPost
GrandParentContentID Used in the request body Grand Parent Content ID of the Forum Post is forum Content ID.
Required parameter for Forum Posts, and not required for any other entity.
ReplyToPostID Used in the request body It is the post Content ID on which you want to reply.
It should always be greater than 0.
Required parameter for Forum Posts, and not required for any other entity.
Optional parameters How to use Description
IsFeatured Used in the request body Used to mark a content as featured.
Possible values:
  • false
  • true
IsSticky Used in the request body Used to mark a Forum Topic as sticky.
Possible values:
  • false
  • true
LockedByUserID Used in the request body User ID of the user who is locking the Forum Topic.
SideBarContent,
ExtraSideBarContent		 Used in the request body Used for CMS Page.
AllowAnonymousComments Used in the request body It allows anonymous users to comment to the entity.
Possible values:
  • false
  • true
Optional parameter for following entities:
  • Article
  • Blog
  • Idea
  • Wiki
Not required for following entities:
  • CMSPage
  • Album
  • ForumGroup
  • Forum
  • ForumTopic
  • ForumPost
AllowAnonymousUpVoting, 
AllowAnonymousDownVoting		 Used in the request body Used to allow anonymous users to 'up vote' and 'down vote' an Idea.
Possible values:
  • false
  • true
AllowComments Used in the request body Used to allow users to comment on any Video.
Possible values:
  • false
  • true
TagsCSV Used in the request body Used to set Tags for the content and they should be passed in CSV format.
RequiresReadConfirmation Used in the request body Set it to true if Content is required to read.

Example Request 

POST https://myintranet.communifire.com/api/content

Body:

{
   "EntityType":3,
   "CategoryID":32,
   "SpaceID":0,
   "ContentTitle":"Jupiter Facts",
   "ContentBody":"Jupiter is the fifth planet from the Sun and the largest in the Solar System.",
   "IsFeatured":false
}
Note: To create other entity types, simply pass the EntityType integer representation of  REST API: System Entity Types : Article, Blog, CMSPage, Wiki, Idea, Albums, Forums, Forum Groups, Forum Topics and Forum Posts.

Example Response

Content ID is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"ToBePublished",
    "ResponseData":2726
}

 

Please Note The content type that you pass in the header of your request should be application/json.

 

Wiki Index

Pages

Intranet Software