Partilhar via


searchquery Action

Provides a search results page.

Parameters

Parameters allow for data to be passed to the action.

Name Type Nullable Unicode Description
orderby
Edm.String True False

List of comma-separated clauses where each clause is an attribute name followed by 'asc' or 'desc'.

options
Edm.String True False

Options are settings configured to search a search term. Eg. lucene, besteffortsearch, groupranking, searchmodelall.

propertybag
Edm.String True False

A collection of the additional properties for search request. Eg. appid, correlationid.

filter
Edm.String True False

Filter criteria to reduce results returned.

entities
Edm.String True False

The default entity list searches across all search-configured entities and fields.

skip
Edm.Int32 True True

The number of search results to skip.

top
Edm.Int32 True True

The number of search results to retrieve. The default is 50, and the maximum value is 100.

search
Edm.String False False

Search term.

count
Edm.Boolean True True

Whether to return the total record count; otherwise false. The default is false.

facets
Edm.String True False

Facets support the ability to drill down into data results after they've been retrieved.

Return type

Type Nullable Description
searchqueryResponse False Contains the response of the searchquery action.

See also