{"id":1973,"date":"2019-07-24T10:23:37","date_gmt":"2019-07-24T08:23:37","guid":{"rendered":"https:\/\/blog.kodono.info\/wordpress\/?p=1973"},"modified":"2019-08-20T09:40:30","modified_gmt":"2019-08-20T07:40:30","slug":"sharepoint-2013-search-rest-api-options","status":"publish","type":"post","link":"https:\/\/blog.kodono.info\/wordpress\/2019\/07\/24\/sharepoint-2013-search-rest-api-options\/","title":{"rendered":"SharePoint 2013 Search REST API options"},"content":{"rendered":"

Finding the documentation for the Search REST API of Sharepoint is difficult…. There is a very old blog post<\/a> that I’m going to replicate here to give more visibility:<\/p>\n

 <\/p>\n

Location of the Search Rest service<\/span><\/strong><\/p>\n

The Search REST service is located at the following URI: http:\/\/host\/site\/_api\/search<\/a><\/p>\n

 <\/p>\n

The Search REST API<\/span><\/strong><\/p>\n

The Search REST service exposed by the URI specified above provides the following methods or entry points:<\/p>\n

 <\/p>\n

 <\/p>\n

\n\n\n\n\n\n
\n

query<\/span><\/p>\n<\/td>\n

\n

http:\/\/host\/site\/_api\/search\/query<\/a><\/p>\n<\/td>\n

\n

Supports HTTP Get and is used to retrieve search results.<\/p>\n<\/td>\n<\/tr>\n

\n

postquery<\/span><\/p>\n<\/td>\n

\n

http:\/\/host\/site\/_api\/search\/postquery<\/a><\/p>\n<\/td>\n

\n

Supports HTTP POST and is used to retrieve search results. This method can be used to overcome URI length restrictions when using the HTTP GET based method “query<\/span>“.<\/p>\n<\/td>\n<\/tr>\n

\n

suggest<\/span><\/p>\n<\/td>\n

\n

http:\/\/host\/site\/_api\/search\/suggest<\/a><\/p>\n<\/td>\n

\n

Supports HTTP GET and is used to retrieve query suggestions.<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n

 <\/p>\n

Query Parameters<\/span><\/strong><\/p>\n

The following table lists the query parameters available for the query <\/span>entry point:<\/p>\n

 <\/p>\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

Name<\/span><\/p>\n<\/td>\n

\n

Description<\/span><\/p>\n<\/td>\n

\n

Type<\/span><\/p>\n<\/td>\n

\n

Default<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

querytext<\/p>\n<\/td>\n

\n

The text of the search query.<\/p>\n<\/td>\n

\n

String – Maximum query text length allowed by the Keyword Query OM is 4096 characters.<\/p>\n<\/td>\n

\n

Empty<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’search is cool’<\/span><\/td>\n<\/tr>\n
\n

querytemplate<\/p>\n<\/td>\n

\n

The query template text.<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Empty<\/p>\n<\/td>\n<\/tr>\n

 <\/td>\n<\/tr>\n
\n

enableinterleaving<\/p>\n<\/td>\n

\n

Specifies if the result sets which are generated by executing query rule actions to add result  block should be mixed with the result set for the original query.<\/p>\n<\/td>\n

\n

bool<\/p>\n<\/td>\n

\n

True<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&enableinterleaving=false<\/span><\/td>\n<\/tr>\n
\n

sourceid<\/p>\n<\/td>\n

\n

Specifies the unique identifier of the Result Source to use for executing the search query.<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Empty<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’term’&sourceid=’8413cd39-2156-4e00-b54d-11efd9abdb89′<\/span><\/td>\n<\/tr>\n
\n

rankingmodelid<\/p>\n<\/td>\n

\n

The GUID of the Rank Model to be used for this search query.<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Empty<\/p>\n<\/td>\n<\/tr>\n

 <\/td>\n<\/tr>\n
\n

startrow<\/p>\n<\/td>\n

\n

A zero-based index of the first search result to be returned.<\/p>\n<\/td>\n

\n

Integer [ >= 0]<\/p>\n<\/td>\n

\n

0<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&startrow=11<\/span><\/td>\n<\/tr>\n
\n

rowlimit<\/p>\n<\/td>\n

\n

The maximum number of search results to be returned, starting at the index specified in  startrow.<\/p>\n<\/td>\n

\n

Integer [ >= 0]<\/p>\n<\/td>\n

\n

10<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&startrow=11&rowlimit=3<\/span><\/td>\n<\/tr>\n
\n

rowsperpage<\/p>\n<\/td>\n

\n

The number of results to return per page.<\/p>\n<\/td>\n

\n

Integer [ >= 0]<\/p>\n<\/td>\n

\n

0<\/p>\n<\/td>\n<\/tr>\n

 <\/td>\n<\/tr>\n
\n

selectproperties<\/p>\n<\/td>\n

\n

Specifies the list of managed properties to return for each search result item. For a managed property to be returned; the Retrievable flag must be set to “true” in the Search Schema.<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Empty<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&selectproperties=’Path,Url,Title,Author’<\/span><\/td>\n<\/tr>\n
\n

culture<\/p>\n<\/td>\n

\n

Specifies the identifier of the language culture of the search query. If present, the value must be a valid LCID of a culture name. A list of LCIDs is available here<\/a>.<\/p>\n<\/td>\n

\n

Integer<\/p>\n<\/td>\n

\n

-1<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&culture=1044<\/span><\/td>\n<\/tr>\n
\n

refiners<\/p>\n<\/td>\n

\n

Specifies a list of refiners to return as a comma-separated list of strings.<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Empty<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&refiners=’companies,contentclass,ContentType,FileExtension,FileType’<\/span><\/td>\n<\/tr>\n
\n

refinementfilters<\/p>\n<\/td>\n

\n

The list of refinement tokens for drilldown into search results. Refinement tokens are returned as part of the RefinementResults table for the search query.<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Empty<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’sharepoint’&refiners=’filetype’&refinementfilters=’filetype:equals(“pptx”)’<\/span><\/td>\n<\/tr>\n
\n

hiddenconstraints<\/p>\n<\/td>\n

\n

Specifies additional query terms that will be appended to the query.<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Empty<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&hiddenconstraints=’powerpoint’<\/span><\/td>\n<\/tr>\n
\n

sortlist<\/p>\n<\/td>\n

\n

Specifies the list of properties to sort the search results by.<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Empty<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&sortlist=’rank:ascending’<\/span><\/td>\n<\/tr>\n
\n

enablestemming<\/p>\n<\/td>\n

\n

Specifies whether stemming is enabled for the query.<\/p>\n<\/td>\n

\n

bool<\/p>\n<\/td>\n

\n

True<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&enablestemming=false<\/span><\/td>\n<\/tr>\n
\n

trimduplicates<\/p>\n<\/td>\n

\n

Specifies whether duplicate items should be removed from search results. This property can also
 be used to collapse hits in the result set.<\/p>\n<\/td>\n

\n

bool<\/p>\n<\/td>\n

\n

True<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&trimduplicates=false<\/span><\/td>\n<\/tr>\n
\n

trimduplicatesincludeid<\/p>\n<\/td>\n

\n

Specifies the value associated with a collapse group, typically used when a user clicks the duplicates link of an item with duplicates.<\/p>\n<\/td>\n

\n

long<\/p>\n<\/td>\n

\n

0L<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&trimduplicates=true&trimduplicatesincludeid=47<\/span><\/td>\n<\/tr>\n
\n

timeout<\/p>\n<\/td>\n

\n

Specifies the amount of time, in milliseconds, before the query request times out.<\/p>\n<\/td>\n

\n

Integer<\/p>\n<\/td>\n

\n

30000<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&timeout=50000<\/span><\/td>\n<\/tr>\n
\n

enablenicknames<\/p>\n<\/td>\n

\n

Specifies whether the exact terms in the search query are used to find matches, or if nicknames
 are used as well.<\/p>\n<\/td>\n

\n

bool<\/p>\n<\/td>\n

\n

False<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&enablenicknames=true<\/span><\/td>\n<\/tr>\n
\n

enablephonetic<\/p>\n<\/td>\n

\n

Specifies whether the phonetic forms of the query terms are used to find matches.<\/p>\n<\/td>\n

\n

bool<\/p>\n<\/td>\n

\n

False<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&enablephonetic=true<\/span><\/td>\n<\/tr>\n
\n

enablefql<\/p>\n<\/td>\n

\n

Specifies whether the query string is according to the FAST Query Language (FQL) syntax.<\/p>\n<\/td>\n

\n

Bool<\/p>\n<\/td>\n

\n

False<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&enablefql=true<\/span><\/td>\n<\/tr>\n
\n

hithighlightedproperties<\/p>\n<\/td>\n

\n

Specifies the list of properties to include in the HitHighlightedProperties for each result item.<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Empty<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&hithighlightedproperties=’Title,Author’<\/span><\/td>\n<\/tr>\n
\n

bypassresulttypes<\/p>\n<\/td>\n

\n

Specifies if the search result item type should be returned for the query results.<\/p>\n<\/td>\n

\n

bool<\/p>\n<\/td>\n

\n

False<\/p>\n<\/td>\n<\/tr>\n

 <\/td>\n<\/tr>\n
\n

processbestbets<\/p>\n<\/td>\n

\n

Specifies if the search promoted results should be returned, if available, as a result set.<\/p>\n<\/td>\n

\n

bool<\/p>\n<\/td>\n

\n

True<\/p>\n<\/td>\n<\/tr>\n

 <\/td>\n<\/tr>\n
\n

clienttype<\/p>\n<\/td>\n

\n

Name of a client which issued query.<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Empty<\/p>\n<\/td>\n<\/tr>\n

 <\/td>\n<\/tr>\n
\n

personalizationdata<\/p>\n<\/td>\n

\n

Gets or sets the unique identifier (GUID) for the current user who submitted the search query.<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Empty<\/p>\n<\/td>\n<\/tr>\n

 <\/td>\n<\/tr>\n
\n

resultsurl<\/p>\n<\/td>\n

\n

Specifies the URL for the page where the search results are going to be displayed.<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Empty<\/p>\n<\/td>\n<\/tr>\n

 <\/td>\n<\/tr>\n
\n

querytag<\/p>\n<\/td>\n

\n

Any custom tags to be used to identify the query. Multiple tags are separated by semicolons.<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Empty<\/p>\n<\/td>\n<\/tr>\n

 <\/td>\n<\/tr>\n
\n

enablequeryrules<\/p>\n<\/td>\n

\n

Specifies if Query Rules are turned on for this query.<\/p>\n<\/td>\n

\n

bool<\/p>\n<\/td>\n

\n

True<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&enablequeryrules=false<\/span><\/td>\n<\/tr>\n
\n

enablesorting<\/p>\n<\/td>\n

\n

Indicates whether results should be sorted.<\/p>\n<\/td>\n

\n

bool<\/p>\n<\/td>\n

\n

True<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/query?querytext=’terms’&enablesorting=false<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n

 <\/p>\n

 <\/p>\n

Suggest Parameters<\/span><\/strong><\/p>\n

The following table lists the query parameters available from the suggest entry point:<\/p>\n

  <\/p>\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

Name<\/span><\/p>\n<\/td>\n

\n

Description<\/span><\/p>\n<\/td>\n

\n

Type<\/span><\/p>\n<\/td>\n

\n

Default<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

querytext<\/p>\n<\/td>\n

\n

The text of the search query.<\/p>\n<\/td>\n

\n

String<\/p>\n<\/td>\n

\n

Empty<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/suggest?querytext=’nad’<\/span><\/td>\n<\/tr>\n
\n

inumberofquerysuggestions<\/p>\n<\/td>\n

\n

The number of query suggestions to retrieve.<\/p>\n<\/td>\n

\n

Integer [ > 0]<\/p>\n<\/td>\n

\n

5<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/suggest?querytext=’nad’&inumberofquerysuggestions=6<\/span><\/td>\n<\/tr>\n
\n

inumberofresultsuggestions<\/p>\n<\/td>\n

\n

The number of personal results to retrieve.<\/p>\n<\/td>\n

\n

Integer [ > 0]<\/p>\n<\/td>\n

\n

5<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/suggest?querytext=’nad’&inumberofresultsuggestions=6<\/span><\/td>\n<\/tr>\n
\n

fprequerysuggestions<\/p>\n<\/td>\n

\n

Specifies whether to retrieve pre-query suggestions or post-query suggestions.<\/p>\n<\/td>\n

\n

bool<\/p>\n<\/td>\n

\n

False<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/suggest?querytext=’nad’&fprequerysuggestions=true<\/span><\/td>\n<\/tr>\n
\n

fhithighlighting<\/p>\n<\/td>\n

\n

Specifies whether the query suggestions should be highlighted. If “true”, the terms
 in the returned query suggestions that match terms in the specified query are  surrounded with <B> and <\/B> HTML tags.<\/p>\n<\/td>\n

\n

bool<\/p>\n<\/td>\n

\n

True<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/suggest?querytext=’nad’&fhithighlighting=true<\/span><\/td>\n<\/tr>\n
\n

fcapitalizefirstletters<\/p>\n<\/td>\n

\n

Specifies whether to capitalize first letters in each term in query suggestions.<\/p>\n<\/td>\n

\n

bool<\/p>\n<\/td>\n

\n

False<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/suggest?querytext=’nad’&fcapitalizefirstletters=true<\/span><\/td>\n<\/tr>\n
\n

showpeoplenamesuggestions<\/p>\n<\/td>\n

\n

Specifies if people names should be included in query suggestions.<\/p>\n<\/td>\n

\n

bool<\/p>\n<\/td>\n

\n

False<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/suggest?querytext=’nad’&showpeoplenamesuggestions=true<\/span><\/td>\n<\/tr>\n
\n

culture<\/p>\n<\/td>\n

\n

Specifies the identifier of the language culture of the search query. If present, the value must be a valid LCID of a culture name. A nice list of LCIDs is available here<\/a>.<\/p>\n<\/td>\n

\n

Integer<\/p>\n<\/td>\n

\n

-1<\/p>\n<\/td>\n<\/tr>\n

http:\/\/host\/site\/_api\/search\/suggest?querytext=’nad’&culture=1044<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n

 <\/p>\n

 <\/p>\n

 References:<\/p>\n