Loading ...

REST API: Search | Communifire Documentation

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

REST API: Search

0 
 /5
0 (0votes)

Search

GET /api/search

Search for 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.
Keyword &Keyword=x - Used in the request URL as a query parameter The search keyword to return content for.
Optional Parameters How to use Description
SpaceIDCSV &SpaceIDCSV=x - Used in the request URL as a query parameter Comma-separated list of unique IDs of spaces from which the content is to be returned.
Don't pass any value to it if you want content from every space, where you have access.
EntityTypeCSV &EntityTypeCSV=x - Used in the request URL as a query parameter

Comma-separated list of entity types of the content to be returned. Here is the list of supported entity types:

  • Forum = 1
  • ForumGroup = 2
  • Article = 3
  • Blog = 4
  • Photo = 6
  • Video = 7
  • Wiki = 9
  • Wall Post = 10
  • CMSPage = 12
  • Space = 13
  • File = 14
  • Album = 18
  • Idea = 44
  • ForumPost = 54
  • ForumTopic = 55
UserIDCSV &UserIDCSV=x - Used in the request URL as a query parameter Comma-separated list of unique IDs of the users whose content is to be returned.
ExactMatch &ExactMatch=x - Used in the request URL as a query parameter If it is set to true, then it will search the exact keyword in the index, otherwise there is no need to set this value.
TagIDCSV &TagIDCSV=x - Used in the request URL as a query parameter Comma-separated list of the IDs of tags in a tag group content should be tagged with.
TagGroupIDCSV &TagGroupIDCSV=x - Used in the request URL as a query parameter Comma-separated list of the IDs of tag group content should be tagged with.
Tags &Tags=x - Used in the request URL as a query parameter The keywords content should be tagged with.
FromDateString &FromDateString=x - Used in the request URL as a query parameter The earliest creation date returned content should have. The date format should be YYYYMMDD.
ToDateString &ToDateString=x - Used in the request URL as a query parameter The latest creation date returned content should have. The date format should be YYYYMMDD.
IsFeatured &IsFeatured=x - Used in the request URL as a query parameter Used to get content marked as "featured".
CategoryID &CategoryID=x - Used in the request URL as a query parameter Category ID for Articles, Blogs, Videos, CMSPages & Ideas.
SearchOnlyTags &SearchOnlyTags=x - Used in the request URL as a query parameter Specifies whether to search for the keyword in tags only or not. True or false.
ParentContentID &ParentContentID=x - Used in the request URL as a query parameter ID of the parent content from which content is to be returned. Required parameter for following entities:
  • Photo
  • Forum
  • Forum Topic
  • Forum Post
Optional parameter for following entities:
  • Wiki - To specify the parent wiki
  • File - To specify Directory ID
  • CMSPage
Not required parameter for following entities:
  • Article
  • Blog
  • Album
  • Video
  • Idea
  • ForumGroup
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.
SortBy &SortBy=x - Used in the request URL as a query parameter Sort content based on a column. Here are the values of Sort Column parameter:
  • Unspecified = 0
  • DateCreated = 1
  • Rating = 2
  • DatePublished = 3
  • DateUpdated = 4
  • ViewCount = 5
  • CommentCount = 6
  • EventStartDate = 7
  • SortOrder = 8
  • VoteCount = 9
  • ContentTitle = 10
  • DateAwarded = 11
  • TagCount = 12
  • MostRelavant = 13
SortOrder &SortOrder=x - Used in the request URL as a query parameter The order in which content is to be sorted. Here are the values of Sort Order parameter:
  • Ascending = 0
  • Descending = 1
  • Unspecified = 2
TitleLength &TitleLength=x - Used in the request URL as a query parameter Number of characters to return for the content title
SummaryLength &SummaryLength=x - Used in the request URL as a query parameter Number of characters to return for the content summary
isGenericContentSearch &IsGenericContentSearch=x - Used in the request URL as a query parameter To fetch only content.

Example Request

GET https://myintranet.communifire.com/api/search?Keyword=report&EntityTypeCSV=3,4&SpaceIDCSV=88&CategoryID=1202&Tags="sales"

Example Response

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

{
   "IsError":false,
   "ResponseMessage":"",
   "ResponseData":[
        {
            "IDProperty":"4-2610",
            "Title":"Our Company Volunteering Program Reaches All-Time High",
            "AutoSuggest":"Our Company Volunteering Program Reaches All-Time High",
            "ParentContentTitle":"",
            "Summary":"The last quarter we say the greatest number of hours volunteer per person in company history. It says a lot about our computer culture.",
            "IsIsolated":false,
            "ContentTitleFilterApplied":"Our Company Volunteering Program Reaches AllhyphenTime High",
            "ContentSummaryFilteredApplied":"The last quarter we say the greatest number of hours volunteer per person in company historydot It says a lot about our computer culturedot",
            "CategoryID":854,
            "WallPostToUserID":0,
            "PermissionCheckAuthorID":114,
            "PermissionCheckEntityID":0,
            "SpaceRoleIDCSV":["530","531","532","533","604"],
            "ContentPageSidebarContent":"",
            "ContentPageSidebarContentEnglish":"",
            "ContentPageExtraSidebarContent":"",
            "ContentPageExtraSidebarContentEnglish":"",
            "DateCreated":"2017-08-15T19:16:55.283",
            "DatePublished":"2017-08-15T19:16:55.283",
            "ShowDate":true,
            "ShowMetaData":true,
            "DateUpdated":"2017-08-15T19:16:55.283",
            "DateCreatedString":"8/15/2017",
            "AuthorUserID":114,
            "AuthorUsername":"diana",
            "AuthorUserDisplayName":"Diana Langley",
            "AuthorUserAvatarImageURL":"https://myintranet.communifire.com/Assets/Uploaded-Photos/avatar-default.jpg",
            "AuthorUserProfileURL":"https://myintranet.communifire.com/people/diana",
            "SpaceID":88,
            "ContentStatusID":1,
            "ContentCurrentWorkFlowStepID":0,
            "SpaceName":"Human Resources",
            "SpaceURL":"/spaces/88/human-resources",
            "EntityType":4,
            "EntityTypeText":"Blog",
            "ContentID":2610,
            "ContentURL":"/spaces/88/human-resources/blogs/general/2610/our-company-volunteering-program-reaches-all-time-high",
            "ContentImageURL":"/Themes/default/images/photo-placeholder.gif",
            "ContentMediaServerRootURL":"https://myintranet.communifire.com/Assets/Uploaded-CMS-Files",
            "ContentMediaServerID":3,
            "WallID":0,
            "ContentStub":"our-company-volunteering-program-reaches-all-time-high",
            "ParentContentStub":"",
            "GrandParentContentStub":"",
            "GreatGrandParentContentStub":"",
            "GreatGrandParentContentID":0,
            "ContentCategoryName":"General",
            "ContentCategoryStub":"general",
            "Tags":"",
            "ContentTagNameFiltered":"",
            "ForumPostForumID":0,
            "ForumPostTopicID":0,
            "EntityIconCssClass":"icon-copy",
            "ExternalVideoType":0,
            "ParentContentID":0,
            "ContentDetailImageURL":"/Themes/default/images/photo-placeholder.gif",
            "ContentFeaturedImage":"",
            "ContentDetailImageName":"",
            "UserIsProfilePublic":false,
            "UserIsActivated":false,
            "CommentCount":0,
            "PageViews":6,
            "Rating":0.0,
            "IsComment":false,
            "IsSpaceLevel":true,
            "IsFeatured":false,
            "IsLatest":false,
            "IsContentPubliclyAccessible":true,
            "IsAddedFromActivityStream":false,
            "ShowRating":true,
            "ShowViewCount":true,
            "ShowCommentCount":true,
            "EventStartDate":"0001-01-01T00:00:00",
            "IsRecurringTime":false,
            "EventEndDate":"0001-01-01T00:00:00",
            "EventScheduleStartDate":"0001-01-01T00:00:00",
            "EventScheduleEndDate":"0001-01-01T00:00:00",
            "EventCountryID":0,
            "EventStateID":0,
            "EventMetroID":0,
            "EventIsAllDay":false,
            "EventIsPrivate":false,
            "EventTypeID":0,
            "IssueCommentIsProjectActive":false,
            "IssueCommentIsInternal":false,
            "IssueCommentIssueID":0,
            "SpaceVisibility":0,
            "TotalChildRecords":0
        }
    ]
}

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

Wiki Index

Pages

Intranet Software