Loading ...

REST API: Update Content Multiple | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Update Content Multiple
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Update Content Multiple

0 
 /5
0 (0votes)

Update Content Multiple

PUT /api/content/multiple

You can update existing multiple contents in a single request. For example, set the expiration dates of multiple articles at once.

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

Method Details

HTTP Method
PUT
Response Format
JSON
Requires Authentication?
YES
Product Version
8.0 and above
Note: Refer to  REST API: Create Content  to check required, not required, and optional parameters for every entity.
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.
ContentID Used in the request body  Unique identifier for content. List of supported entities: Articles, Blogs, CMS Pages, Wikis, Ideas, Photos, Albums, Forums, Forum Groups, Forum Topics, Forum Posts.
Content JSON Used in the request body This is JSON that represents a content object that you're updating. This should be of the format seen below in the sample given.
Optional Parameters How to use Description
ContentTitle Used in the request body Content Title of the entity to be updated.
ContentSummary Used in the request body Content Summary of Articles, Blogs or Videos to be updated.
ContentBody Used in the request body Content Body of the entity to be updated.
CategoryID Used in the request body CategoryID for Articles, Blogs, CMSPage or Ideas to be updated.
ParentContentID Used in the request body Used in Wikis, Forums, Forum Topics, Forum Posts to specify the parent content under which this content is updated.
ContentStageID Used in the request body Used in Ideas to specify Idea stage.
IsFeatured Used in the request body Used to mark content as "featured".

true= Set the content as featured
StatusID Used in the request body

Enter number for corresponding status:

1 - Published

2 - Draft

5 - Expired 
IsContentAvailablePostExpiry Used in the request body Used to indicate if content will be visable after exipration date.

true= content will be visable after expiration date
DateExpired Used in the request body Used to update Expiration date of content.

UTC Time format required (24HR): YYYY-MM-DDTHH:MM:SSZ

NOTES:

  • If changing status to 5 (Expired), you must put a "DateExpired" property along with it.
  • If putting "DateExpired" on content in a space where "Content Expiration" is not enabled in settings, the content will still have the new Date Expiration as a part of the content, but date will not be visible unless the setting is enabled: Content Expiration 

EXAMPLES:

Example 1

Example Request

PUT https://myintranet.communifire.com/api/content/multiple

Body:

"[
{
   \"ContentID\":9740,
   \"ContentTitle\":\"Jupiter is the fifth planet from the Sun\",
   \"ContentBody\":\"Jupiter is primarily composed of hydrogen with a quarter of its mass being helium, although helium only comprises about a tenth of the number of molecules. It may also have a rocky core of heavier elements, but like the other giant planets, Jupiter lacks a well-defined solid surface. \"
},
{
   \"ContentID\":9739,
   \"ContentTitle\":\"Lorem ipsum dolor sit amet\",
   \"ContentBody\":\"Enim praesent elementum facilisis leo vel. Lorem mollis aliquam ut porttitor leo a diam sollicitudin tempor. Lobortis scelerisque fermentum dui faucibus in. In hac habitasse platea dictumst vestibulum rhoncus. Adipiscing vitae proin sagittis nisl rhoncus mattis rhoncus. Eget gravida cum sociis natoque penatibus et magnis. Scelerisque viverra mauris in aliquam sem. Urna cursus eget nunc scelerisque viverra mauris \"
},
{
   \"ContentID\":8763,
   \"ContentTitle\":\"Mauris in aliquam sem fringilla ut morbi\",
   \"ContentBody\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. At in tellus integer feugiat. Volutpat est velit egestas dui id. Ut etiam sit amet nisl purus in mollis nunc. Massa sed elementum tempus egestas sed\"
},
{
   \"ContentID\":9741,
   \"ContentTitle\":\"Adipiscing commodo elit at imperdiet dui accumsan sit amet nulla\",
   \"ContentBody\":\"Sed arcu non odio euismod. Dolor sed viverra ipsum nunc aliquet bibendum enim facilisis gravida. Vulputate eu scelerisque felis imperdiet proin fermentum. Commodo odio aenean sed adipiscing diam. Ipsum a arcu cursus vitae. Porttitor rhoncus dolor purus non enim. Malesuada pellentesque elit eget gravida\"
},
]"

 

Note: JSON data above is stringified.

Example Response

The response will contain the status for each content that was requested in the Update request:

[
    {
        "IsError": false,
        "ResponseMessage": "The content is published.",
        "ResponseData": 9740
    },
    {
        "IsError": false,
        "ResponseMessage": "The content is published.",
        "ResponseData": 9739
    },
    {
        "IsError": false,
        "ResponseMessage": "The content is published.",
        "ResponseData": 8763
    },
    {
        "IsError": false,
        "ResponseMessage": "The content is published.",
        "ResponseData": 9741
    }
]

 

Example 2

Example Request

 

Body:


"[ { 
     \"ContentID\":7999, 
     \"StatusID\": 5, 
     \"IsContentAvailablePostExpiry\":true, 
     \"DateExpired\":\"2021-12-21T06:30:00Z\" }, 

   { 
     \"ContentID\":7998, 
     \"StatusID\": 5, 
     \"IsContentAvailablePostExpiry\":true, 
     \"DateExpired\":\"2021-12-21T06:30:00Z\" }, 

   {
     \"ContentID\":7995, 
     \"StatusID\": 5, 
     \"IsContentAvailablePostExpiry\":true, 
     \"DateExpired\":\"2021-12-21T06:30:00Z\" }, 

   { 
     \"ContentID\":9741, 
     \"StatusID\": 5, 
     \"IsContentAvailablePostExpiry\":false, 
     \"DateExpired\":\"2021-12-21T06:30:00Z\" }, 
]"

Example Response


 [
    {
        "IsError": false,
        "ResponseMessage": "Expired. Source Object: 
        {\r\n  \"ContentID\": 7999,
         \r \n \"StatusID\": 5,
         \r\n  \"IsContentAvailblePostExpiry\": true,
         \r\n  \"DateExpired\": \"2021-12-21T06:30:00Z\"
         \r\n}","ResponseData": 7999
    },
    {
        "IsError": false,
        "ResponseMessage": "Expired. Source Object: 
        {\r\n  \"ContentID\": 7998,
         \r\n  \"StatusID\": 5,
         \r\n  \"IsContentAvailablePostExpiry\": true,
         \r\n  \"DateExpired\": \"2021-12-21T06:30:00Z\"
         \r\n}","ResponseData": 7998
    },
    {
        "IsError": false,
        "ResponseMessage": "Expired. Source Object:
        {\r\n  \"ContentID\": 7995,
         \r\n  \"StatusID\": 5,
         \r\n  \"IsContentAvailablePostExpiry\": true,
         \r\n  \"DateExpired\": \"2021-12-21T06:30:00Z\"
         \r\n}","ResponseData": 7995
    },
    {
        "IsError": false,
        "ResponseMessage": "Expired. Source Object: 
        {\r\n  \"ContentID\": 9741,
         \r\n  \"StatusID\": 5,
         \r\n  \"IsContentAvailablePostExpiry\": false,
         \r\n  \"DateExpired\": \"2021-12-21T06:30:00Z\"
         \r\n}","ResponseData": 9741
    }
]

 

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

Wiki Index

Pages

Intranet Software