Content search with search terms highlighted
GET {{baseUrl}}/.api/api.svc/search/content?q={Keyword to search for}
This endpoint searches through your digital workplace for the objects you specify, with additional search parameters, and returns the object details.
Request Params
| Key | Datatype | Required | Description |
| q | string | | (Required) -String
This parameter is a search string, through which you can search for anything containting that word on your digitial workplace. Multiple words and be searched for at the same time using a comma separated list.
Please note: You cannot search for members using this endpoint. |
| application | string | | Array[string]
Used to specify what type of object you are looking for in your digital workplace. In other words the folderList of application types on your digital workplace.
The available object values are: Unknown, Blog, Wiki, Document, Forum, Calendar, Pages, Space |
| archives | string | | Boolean
This parameter is used to filter archieved content and whether to include them or not in your search. The value here is either true or false. |
| microblog | string | | Boolean
This parameter is used to determine if you want to Include microblog content in your search results. The value here is either true or false. |
| detailed | string | | Boolean
This parameter loads additional data about the object you are searching for and displays the content within it, as well as the author of the content and information about them. The value here is either true or false. |
| hl | string | | Boolean
This parameter returns the HTML form for the results of the query with the keyword bolded. The value here is either true or false. |
| rows | number | | Integer
The items per page to display. Up to 12 items will be displayed by default. |
| page | number | | Integer
Page number to begin from. The default value here is 1 |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | The type of response data to request. By default this endpoint will respond with XML.
The options are:
- application/json
- application/xml |
RESPONSES
status: OK
{"minRequestPeriod":0,"requestSupportCode":637780451562803940,"dictionary":null,"response":{"__type":"namevalue:http://schemas.iglooplatform.com/Igloo.Old.Common","name":"results","value":{"__type":"SearchResults:http://schemas.iglooplatform.com/Igloo.Old.Common","count":1,"facets":[],"hit":[{"__type":"ExtendedObjectHit:#Igloo.Old.Common.Search","ApplicationType":6,"CommunityId":"{{$randomUUID}}","CreatedById":"{{$randomUUID}}","IsArchived":false,"ModifiedDate":"/Date(1642447642893)/","NumberOfComments":0,"ObjectId":"{{$randomUUID}}","ObjectType":21,"Content":"second event description. ","CreatedBy":{"__type":"Persona:http://schemas.iglooplatform.com/Igloo.Old.Common","id":"{{$randomUUID}}","href":"/.profile/{{$randomFirstName}}","navType":0,"isEnabled":true,"name":{"firstName":"{{$randomFirstName}}","lastName":"{{$randomLastName}}","fullName":"{{$randomFullName}}","initials":"{{$randomNameSuffix}}"},"namespace":"{{$randomFirstName}}","isActivated":true,"onlinestatus":{"lastvisit":"2022-01-17T14:07:44-05:00","statusText":""},"status":{},"anonymousname":"","hasPhoto":false,"sharePhoto":true,"email":"{{$randomEmail}}","reputation":700,"sendEmailOnMessage":true,"smsAddress":""},"Description":"second event summary.","FileFormat":null,"FusionQueryId":"{{$randomUUID}}","Highlights":[{"Key":"title","Value":["\u003cstrong class=\"highlight\"\u003esecond\u003c/strong\u003e event"]},{"Key":"description","Value":["\u003cstrong class=\"highlight\"\u003esecond\u003c/strong\u003e event summary."]},{"Key":"content","Value":["\u003cstrong class=\"highlight\"\u003esecond\u003c/strong\u003e event description."]}],"Href":"/events/company_events/second_event","Keywords":[],"Labels":null,"LikeCount":0,"Title":"second event","ViewCount":1}]}}}