Loading ...

REST API: Get Forum | Communifire Documentation

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

REST API: Get Forum

0 
 /5
0 (0votes)

Get Forum

GET /api/content/{ContentID}

Get a forum. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
GET
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.
ContentID Used in the request URL as a path parameter Unique identifier for a particular forum.

Example Request

GET https://myintranet.communifire.com/api/content/293

Example Response

Forum JSON object is returned as ResponseData.


{   
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":
    {
        "ContentID":293,
        "EntityType":2,
        "ContentTypeID":2,
        "ContentTitle":"Jupiter Facts",
        "ContentStub":"jupiter-facts",
        "AuthorID":1,
        "AuthorUserName":"jon",
        "UpdatedByUserID":1,
        "UpdatedByUserDisplayName":"Jon Smith",
        "ContentVersionID":1,
        "SpaceID":0,
        "WorkflowID":0,
        "CurrentWorkflowStepID":0,
        "StatusID":1,
        "ContentStageID":null,
        "ContentStageName":null,
        "DateCreated":"2016-01-25T09:30:10.7",
        "DatePublished":"2016-01-25T09:30:10.7",
        "DateUpdated":"2016-01-25T09:30:10.7",
        "SpaceName":null,
        "SpaceURL":null,
        "AuthorDisplayName":"Jon Smith",
        "AuthorEmail":"acme@acme.com",
        "AuthorFirstName":"Jon",
        "AuthorLastName":"Smith",
        "AuthorProfileUrl":"https://myintranet.communifire.com/people/jon",
        "LockedByUserProfileUrl":null,
        "LockedByUserDisplayName":null,
        "IsLatest":false,
        "DateCreatedString":"7 seconds ago",
        "DatePublishedString":"7 seconds ago",
        "DateUpdatedString":"7 seconds ago"
    }
}


Please Note Pass application/json as the content type in the header of your request.

Wiki Index

Pages

Intranet Software