SearchRequest Document (Data API 17.4)
Document representing a search request for retrieving items within the Data API. The query is a potentially complex set of expressions. The fields that each query supports are defined within the search resource.
| Property | Type | Constraints | Description |
|---|---|---|---|
count
|
Integer | maxIntegerValue=200, minIntegerValue=1 | The number of returned documents. |
expand
|
[String] | List of expansions to be applied to each search results. Expands are optional. | |
query
|
Query {TermQuery, TextQuery, BoolQuery, MatchAllQuery, FilteredQuery} | mandatory=true, nullable=false | The query to apply |
select
|
String | The field to be selected. | |
sorts
|
[Sort] | The list of sort clauses configured for the search request. Sort clauses are optional. | |
start
|
Integer | minIntegerValue=0 | The zero-based index of the first search hit to include in the result. |
X
OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
