Loading ...

REST API: Get Content List | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Get Content List
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 43

REST API: Get Content List

0 
 /5
0 (0votes)

Get Content List

GET /api/content/list

Get a list of content. List of supported entities: Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas, Photos, Albums, Forums, Forum Groups, Forum Topics, Forum Posts. 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.
Optional Parameters How to use Description
EntityType &EntityType=x - Used in the request URL (see below) 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
  • Wiki = 9
  • CMSPage = 12
  • File = 14
  • Album = 18
  • Idea = 44
  • ForumPost = 54
  • ForumTopic = 55
EntityTypeCSV &EntityTypeCSV- Used in the request URL (see below) Comma-separated list of entity types to return.
CategoryID &CategoryID=x - Used in the request URL (see below) Category ID for Articles, Blogs, Videos, CMS Pages & Ideas.
ParentContentID &ParentContentID=x - Used in the request URL (see below) Parent ID of the content. Used to get Topics in a Forum.
SpaceID &SpaceID=x - Used in the request URL (see below) Unique ID of the space from which the content is to be returned.
Don't pass any value if you want content from every space, where you have access.
UserID &UserID=x - Used in the request URL (see below) Unique ID of the user whose content is to be returned.
EntityStatus &EntityStatus=x - Used in the request URL (see below) Status of the content. Here are the values of Entity Status parameter:
  • PendingWorkflow = 0
  • Published = 1
  • Draft = 2
  • Declined = 3
  • Updated = 4
  • Expired = 5
  • Spam = 6
  • All = 7
  • DelayedPublishing = 8
  • TemporarilySaved = 9
  • UnderProcessing = 10
  • Deleted = 11
IsFeatured &IsFeatured=x - Used in the request URL (see below) Used to get content marked as "featured".
DatePublishedTime &DatePublishedTime=x - Used in the request URL (see below) Returns content that was published before the specified date time.
CategoryName &CategoryName=x - Used in the request URL Specifies the category of the content.
CategoryNameCSV &CategoryNameCSV=x - Used in the request URL Specifies the categories to return content for.
MarkedAsAnswer &MarkedAsAnswer=x - Used in the request URL Set it to true to get only answered discussion topics, else false.
ForMySpaces &ForMySpaces=x - Used in the request URL Set to true to return only content from spaces the user is a member of, else false.
ShowExpired &ShowExpired=x - Used in the request URL Set to true to include content that is expired and hidden.
SortColumn &SortColumn=x - Used in the request URL (see below) Sort content based on a column. Here are the values of Sort Column parameter:
  • DateCreated = 1
  • Rating = 2
  • DatePublished = 3
  • DateUpdated = 4
  • ViewCount = 5
  • CommentCount = 6
  • EventStartDate = 7
  • SortOrder = 8 (When SortOrder column is set for the content)
  • VoteCount = 9
  • ContentTitle = 10
  • DateAwarded = 11
  • TagCount = 12
  • MostRelavant = 13
SortOrder &SortOrder=x - Used in the request URL (see below) The order in which content is to be sorted. Here are the values of Sort Order parameter:
  • Ascending = 0
  • Descending = 1
StartPage &StartPage=x - Used in the request URL (see below) Specifies the starting page of list to be returned.
PageLength &PageLength=x - Used in the request URL (see below) Specifies the number of results to be returned per page.
LogView &LogView=true - Used in the request URL as a query parameter Logs the API call as an action in User Activity when set to true

Example Request #1

 Get https://myintranet.communifire.com/api/content/list?EntityType=6

Example Response #1

Content JSON object is returned as ResponseData. Note that some properties are removed from this sample to make it shorter.

"ResponseData": [
        {
            "ContentID": 10881,
            "EntityType": 6,
            "ContentTypeID": 6,
            "ContentTitle": "pexels-piccinng-3075993",
            "ContentStub": "pexels-piccinng-3075993",
            "ContentBody": "",
            "ContentBodyUnprocessed": "",
            "ContentSummary": "",
            "AuthorID": 98,
            "AuthorUserName": "Asmita",
            "UpdatedByUserID": 98,
            "UpdatedByUserDisplayName": "Asmita Srivastava",
            "UpdatedByUserUsername": "Asmita",
            "UpdatedByUserEmail": "asmita@axerosolutions.com",
            "UpdatedByUserFirstName": "Asmita",
            "UpdatedByUserLastName": "Srivastava",
            "UpdatedByUserAvatarImageUrl": "https://myintranet.communifire.com/Assets/Uploaded-Photos/98/4f80da00-ed72-4131-acc4-1f100b835021.jpeg",
            "UpdatedByUserProfileUrl": "https://myintranet.communifire.com/people/Asmita",
            "ParentContentID": 10879,
            "ContentVersionID": 0,
            "SpaceID": 0,
            "WorkflowID": 0,
            "CurrentWorkflowStepID": 0,
            "StatusID": 1,
            "DateCreated": "2022-10-18T04:11:01.707",
            "DatePublished": "2022-10-18T04:11:08.033",
            "DateUpdated": "2022-10-18T04:11:01.707",
            "IsFeatured": false,
            "ViewCount": 2,
            "DownloadCount": 2,
            "CommentCount": 0,
            "Rating": 0.0,
            "MetaTitle": "pexels-piccinng-3075993",
            "MetaDescription": "",
            "MetaKeywords": "",
            "ContentFeaturedImage": "de40c5f9-f89c-4b4c-9c73-fe8783f5f9b7.jpeg",
            "ContentThumbImage": "de40c5f9-f89c-4b4c-9c73-fe8783f5f9b7.jpeg",
            "ContentFeaturedImageFullURL": "https://myintranet.communifire.com/fileattachment?file=rCgDEy3eLOMzpRxi%2FHb0TQ%3D%3D&v=0&isPhotoImage=true&isFeaturedImage=true",
            "ContentThumbImageFullURL": "https://myintranet.communifire.com/fileattachment?file=rCgDEy3eLOMzpRxi%2FHb0TQ%3D%3D&v=0&isPhotoImage=true&isThumbImage=true",
            "PageH1Content": "",
            "HeadCustomContent": "",
            "SideBarContent": "",
            "ContentExternalID": "",
            "ExtraSideBarContent": "",
            "ExternalURL": "",
            "AllowRating": true,
            "AllowComments": true,
            "AllowLikes": true,
            "LikesCount": 0,
            "DoesCurrentUserLike": false,
            "ContentMediaServerID": 1,
            "ExternalContentType": 0,
            "ContentMediaFileName": "325149a9-e32f-4efc-8555-f6c21c0dfd02.jpeg",
            "ContentMediaServerRootURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos",
            "AuthorDisplayName": "Asmita Srivastava",
            "AuthorEmail": "asmita@axerosolutions.com",
            "AuthorFirstName": "Asmita",
            "AuthorLastName": "Srivastava",
            "AuthorAvatarImageUrl": "https://myintranet.communifire.com/Assets/Uploaded-Photos/98/4f80da00-ed72-4131-acc4-1f100b835021.jpeg",
            "AuthorProfileUrl": "https://myintranet.communifire.com/people/Asmita",
            "TagsCSV": "",
            "DateCreatedString": "2 days ago",
            "DateCreatedShortString": "2 days ago",
            "DatePublishedString": "2 days ago",
            "DatePublishedShortString": "2 days ago",
            "DateUpdatedString": "2 days ago",
            "DateUpdatedShortString": "2 days ago",
            "ContentURL": "https://myintranet.communifire.com/photo/Asmita/photo/10881",
            "ContentVersionURL": "/photo/Asmita/photo/10881?versionid=0",
            "IsPublishedFromDraftMode": false,
            "ParentContentTitle": "Photo",
            "ParentContentURL": "https://myintranet.communifire.com/album/10879/Asmita/photo",
            "IsPublishedFromUnderProcessingMode": false,
            "IsBeingAddedViaExternalSource": false,
            "IsWallContent": false,
            "HasRead": false,
            "ContentFileSize": 4112893.0,
            "ContentFileSizeString": "3.9MB",
            "ContentTypeIconCSSClass": "icon-picture",
            "IsEditable": true,
            "IsWOPI": false,
            "IsDeletable": true,
            "IsDownloadable": false,
            "IsChekoutable": false,
            "IsUndochekoutable": false,
            "IsChekinable": false,
            "IsRestoreable": false,
            "IsPurgeable": false,
            "IsHistoryViewable": true,
            "IsMoveable": false,
            "IsChildContentCreationAllowed": false,
            "IsContentCreationAllowed": false,
            "ContentMediaOnlineViewUrl": "https://myintranet.communifire.com/files/view/10881",
            "ContentMediaUrl": "https://myintranet.communifire.com/fileattachment?file=rCgDEy3eLOMzpRxi%2FHb0TQ%3D%3D&v=0&viewfile=1&type=jpeg",
            "ContentHistoryUrl": "",
            "GoogleDocsEditUrl": "javascript:PopupCenter('/AjaxTemplates/GoogleDocsFile.aspx?cid=10881&vid=0','Google Docs',800,600)",
            "ViewerVote": 0,
            "VoteCount": 0,
            "IsDirectory": false,
            "IsActivityStreamAlbum": false,
            "LastChildAuthorUserID": 0,
            "LastGrandChildAuthorUserID": 0,
            "TotalChildRecords": 0,
            "TotalGrandChildRecords": 0,
            "IsSticky": false,
            "IsAnswered": false,
            "ParentContentStub": "photo",
            "AuthorRankImageUrl": "https://myintranet.communifire.com/Assets/Uploaded-Photos/rank-professional.gif",
            "AuthorRankName": "Professional",
            "IsContentAvailablePostExpiry": false,
            "ContentIDCode": "rCgDEy3eLOMzpRxi%2FHb0TQ%3D%3D",
            "SystemName": "",
            "IsExternalContent": false,
            "IsAnonymous": false,
            "OriginalAuthorID": 98,
            "DateCreatedISOString": "2022-10-18T00:11:01.7070000",
            "DateCreatedFullString": "Tuesday, October 18, 2022 at 12:11 AM",
            "SendUpdateNotifications": false,
            "SendSMSTextNotification": false,
            "TenantID": 1
        },

 

Example Request #2

GET https://myintranet.communifire.com/api/content/list?EntityType=3&CategoryID=&SpaceID=&UserID=&EntityStatus=1&IsFeatured=False&SortColumn=1&SortOrder=0&DatePublishedTime=1/13/2016 12:00:00&StartPage=1&PageLength=3

Example Response #2

Content JSON object is returned as ResponseData. Note that some properties are removed from this sample to make it shorter.

   {
   "IsError":false,
   "ResponseMessage":"",
   "TotalRecords": 93
   "ResponseData":[
      {
         "ContentMediaBytes":null,
         "ContentID":2307,
         "EntityType":3,
         "ContentTypeID":3,
         "ContentTitle":"Venus Facts",
         "ContentStub":"venus-facts",
         "ContentBody":"Venus is the second planet from the Sun, orbiting it every 224.7 Earth days. It has no natural satellite. It is named after the Roman goddess of love and beauty. After the Moon, it is the brightest natural object in the night sky, reaching an apparent magnitude of −4.6, bright enough to cast shadows.",
         "ContentBodyUnprocessed":"Venus is the second planet from the Sun, orbiting it every 224.7 Earth days. It has no natural satellite. It is named after the Roman goddess of love and beauty. After the Moon, it is the brightest natural object in the night sky, reaching an apparent magnitude of −4.6, bright enough to cast shadows.",
         "ContentSummary":"Venus is the second planet from the Sun, orbiting it every 224.7 Earth days. It has no natural satellite. It is named after the Roman goddess of love and beauty. After the Moon, it is the brightest natural object in the night sky, reaching an apparent magnitude of −4.6, bright enough to cast shadows.",
         "AuthorID":1,
         "AuthorUserName":"jon",
         "UpdatedByUserID":1,
         "UpdatedByUserDisplayName":"Jon Smith",
         "CategoryID":32,
         "ParentContentID":0,
         "ContentVersionID":1,
         "SpaceID":0,
         "WorkflowID":0,
         "CurrentWorkflowStepID":0,
         "StatusID":1,
         "ContentStageID":null,
         "ContentStageName":null,
         "DateCreated":"2016-01-25T13:02:40.237",
         "DatePublished":"2016-01-25T13:02:40.237",
         "DateUpdated":"2016-01-25T13:02:40.237",
         "IsFeatured":false,
         "ViewCount":0,
         "CommentCount":0,
         "Rating":0.0,
         "MetaTitle":"Venus Facts",
         "MetaDescription":"Venus is the second planet from the Sun, orbiting it every 224.7 Earth days.",
         "MetaKeywords":"",
         "ContentMediaServerRootURL":"http://myintranet.communifire.com/Assets/Uploaded-CMS-Files",
         "SpaceName":null,
         "SpaceURL":null,
         "CategoryName":"Planets",
         "CategoryStub":"planets",
         "AuthorDisplayName":"Jon Smith",
         "AuthorEmail":"acme@acme.com",
         "AuthorFirstName":"Jon",
         "AuthorLastName":"Smith",
         "AuthorAvatarImageUrl":"http://myintranet.communifire.com/Assets/Uploaded-Photos/884af119-4937-4b33-a795-826cda3d19a3.png",
         "AuthorProfileUrl":"http://myintranet.communifire.com/people/jon",
         "LockedByUserProfileUrl":null,
         "LockedByUserDisplayName":null,
         "IsLatest":false,
         "TagsCSV":null,
         "TagsIDCSV":null,
         "DateCreatedString":"15 minutes ago",
         "DatePublishedString":"15 minutes ago",
         "DateUpdatedString":"15 minutes ago",
         "ContentURL":"/articles/planets/2307/venus-facts"

      },
      {
         "ContentMediaBytes":null,
         "ContentID":2306,
         "EntityType":3,
         "ContentTypeID":3,
         "ContentTitle":"Mars Facts",
         "ContentStub":"mars-facts",
         "ContentBody":"Mars is the fourth planet from the Sun and the second smallest planet in the Solar System, after Mercury. Mars is a terrestrial planet with a thin atmosphere, having surface features reminiscent both of the impact craters of the Moon and the valleys, deserts, and polar ice caps of Earth.",
         "ContentBodyUnprocessed":"Mars is the fourth planet from the Sun and the second smallest planet in the Solar System, after Mercury. Mars is a terrestrial planet with a thin atmosphere, having surface features reminiscent both of the impact craters of the Moon and the valleys, deserts, and polar ice caps of Earth.",
         "ContentSummary":"Mars is the fourth planet from the Sun and the second smallest planet in the Solar System, after Mercury.",
         "AuthorID":1,
         "AuthorUserName":"jon",
         "UpdatedByUserID":1,
         "UpdatedByUserDisplayName":"Jon Smith",
         "CategoryID":32,
         "ParentContentID":0,
         "ContentVersionID":1,
         "SpaceID":0,
         "WorkflowID":0,
         "CurrentWorkflowStepID":0,
         "StatusID":1,
         "ContentStageID":null,
         "ContentStageName":null,
         "DateCreated":"2016-01-25T13:00:19.193",
         "DatePublished":"2016-01-25T13:00:19.193",
         "DateUpdated":"2016-01-25T13:00:19.193",
         "IsFeatured":false,
         "ViewCount":0,
         "CommentCount":0,
         "Rating":0.0,
         "MetaTitle":"Mars Facts",
         "MetaDescription":"Mars is the fourth planet from the Sun and the second smallest planet in the Solar System",
         "MetaKeywords":"",
         "ContentMediaServerRootURL":"http://myintranet.communifire.com/Assets/Uploaded-CMS-Files",
         "SpaceName":null,
         "SpaceURL":null,
         "CategoryName":"Planets",
         "CategoryStub":"planets",
         "AuthorDisplayName":"Jon Smith",
         "AuthorEmail":"acme@acme.com",
         "AuthorFirstName":"Jon",
         "AuthorLastName":"Smith",
         "AuthorAvatarImageUrl":"http://myintranet.communifire.com/Assets/Uploaded-Photos/884af119-4937-4b33-a795-826cda3d19a3.png",
         "AuthorProfileUrl":"http://myintranet.communifire.com/people/jon",
         "LockedByUserProfileUrl":null,
         "LockedByUserDisplayName":null,
         "IsLatest":false,
         "TagsCSV":null,
         "TagsIDCSV":null,
         "DateCreatedString":"17 minutes ago",
         "DatePublishedString":"17 minutes ago",
         "DateUpdatedString":"17 minutes ago",
         "ContentURL":"/articles/planets/2306/mars-facts"
      },
      {
         "ContentMediaBytes":null,
         "ContentID":2304,
         "EntityType":3,
         "ContentTypeID":3,
         "ContentTitle":"Jupiter Facts",
         "ContentStub":"jupiter-facts",
         "ContentBody":"Jupiter is the fifth planet from the Sun and the largest in the Solar System. It is a giant planet with a mass one-thousandth that of the Sun, but two and a half times that of all the other planets in the Solar System combined.",
         "ContentBodyUnprocessed":"Jupiter is the fifth planet from the Sun and the largest in the Solar System. It is a giant planet with a mass one-thousandth that of the Sun, but two and a half times that of all the other planets in the Solar System combined.",
         "ContentSummary":"Jupiter is the fifth planet from the Sun and the largest in the Solar System.",
         "AuthorID":1,
         "AuthorUserName":"jon",
         "UpdatedByUserID":1,
         "UpdatedByUserDisplayName":"Jon Smith",
         "CategoryID":32,
         "ParentContentID":0,
         "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",
         "IsFeatured":false,
         "ViewCount":0,
         "CommentCount":0,
         "Rating":0.0,
         "MetaTitle":"Jupiter Facts",
         "MetaDescription":"Jupiter is the fifth planet from the Sun and the largest in the Solar System.",
         "MetaKeywords":"",
         "ContentMediaServerRootURL":"http://myintranet.communifire.com/Assets/Uploaded-CMS-Files",
         "SpaceName":null,
         "SpaceURL":null,
         "CategoryName":"Planets",
         "CategoryStub":"planets",
         "AuthorDisplayName":"Jon Smith",
         "AuthorEmail":"acme@acme.com",
         "AuthorFirstName":"Jon",
         "AuthorLastName":"Smith",
         "AuthorAvatarImageUrl":"http://myintranet.communifire.com/Assets/Uploaded-Photos/884af119-4937-4b33-a795-826cda3d19a3.png",
         "AuthorProfileUrl":"http://myintranet.communifire.com/people/jon",
         "LockedByUserProfileUrl":null,
         "LockedByUserDisplayName":null,
         "IsLatest":false,
         "TagsCSV":null,
         "TagsIDCSV":null,
         "DateCreatedString":"7 seconds ago",
         "DatePublishedString":"7 seconds ago",
         "DateUpdatedString":"7 seconds ago",
         "ContentURL":"/articles/planets/2304/jupiter-facts"
         "ParentContentURL":
      }
   ] 
}

 

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

 

Wiki Index

Pages

Intranet Software