Loading ...

REST API: Get Queued Workflow Content | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Get Queued Workflow Content
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 10

REST API: Get Queued Workflow Content

0 
 /5
0 (0votes)

Get Queued Workflow Content

GET /api/content/workflow/queued

Get a list of content under workflow. 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.
SpaceID &SpaceID=x - Used in the request URL as a query parameter ID of the space from which the content is to be returned.
EntityType &EntityType=x - Used in the request URL as a query parameter The entity type of the content to be returned. Here are the values of Entity Type parameter:
  • Forum = 1
  • ForumGroup = 2
  • Article = 3
  • Blog = 4
  • Photo = 6
  • Video = 7
  • Album = 18
  • Wiki = 9
  • File = 14
  • Idea = 44
  • Space = 13
  • ArticleComment = 24
  • BlogComment = 25
  • EventComment = 26
  • PhotoComment = 27
  • AlbumComment = 28
  • VideoComment = 29
  • WikiComment = 31
  • FileComment = 32
  • WallComment = 33
  • IdeaComment = 45
  • ForumPost = 54
  • ForumTopic = 55
Optional Parameters How to use Description
RoleID &RoleID=x - Used in the request URL as a query parameter ID value which uniquely identifies each role in the Communifire. Generated automatically. This cannot be changed.
StartPage &StartPage=x - Used in the request URL as a query parameter Specifies the starting page of list to be returned.
PageLength &PageLength=x - Used in the request URL as a query parameter Specifies the number of results to be returned per page.

Example Request

GET https://myintranet.communifire.com/api/content/workflow/queued?EntityType=5&SpaceID=0&RoleID=1&StartPage=1&PageLength=100

Example Response

Search results JSON object is returned as ResponseData.


{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData": [
        {
            "EntityID":242,
            "EntityType":"Space",
            "Headline":"New Hire Start",
            "Summary":"<p>We will start our recruitment process from Monday</p>
            "DateCreated":"2016-02-10T10:32:51.89",
            "UserName":"bill",
            "UserEmail":"acme@acme.com",
            "FirstName":"Bill",
            "LastName":"Lombard",
            "AvatarPath":"0",
            "UserID":1350,
            "CommentCount":0,
            "Role":"SiteAdministrator",
            "SpaceID":0,
            "StepID":1,
            "StatusID":0,
            "CategorySEOName":"",
            "EntitySEOName":"New Hire Start",
            "Section":"Space",
            "MediaServerRootURL":"http://myintranet.communifire.com/Assets/Uploaded-Photos",
            "Views":0,
            "ForumPostForumID":0,
            "ForumPostTopicID":0,
            "IsVisiblePublicly":false,
            "ITProjectID":0,
            "ITProjectIsActive":false,
            "FileDirectoryID":0,
            "SystemEntityType":0,
            "TagName":"",
            "ContentMediaServerID":0
        }
    ]
}

 

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

 

Wiki Index

Pages

Intranet Software