This object allows callers to construct advanced search queries.
For example, when results are required to be sorted in either ascending or descending
order, the optional SearchSort.sort field can be
used to indicate the type of sorting that should be used.
Fields
| query
|
The query to use for the search.
This field is required.
|
| options
|
Additional options that affect the search. Use this options field to configure settings
such as the page size or page number from a paginated result.
This field is optional.
|
| sort
|
Sorting options such as field to sort by, order (e.g. ascending, descending), and attribute type (when sorting by attributes).
This field is optional.
|
Example
- Search request with 'US-TX' as the search term
{
"query": {
"query": "US-TX"
},
"options": {
"pageSize": 50,
"pageNumber" 1
},
"sort": {
"field": "name",
"order": "asc"
}
}
Example
- Search request with 'Augustus' as the search term and 'FOUNDER' as the attribute.
{
"query": {
"query": "Augustus",
"attribute": "FOUNDER"
},
"options": {
"pageSize": 50,
"pageNumber" 1
},
"sort": {
"field": "name",
"order": "asc"
}
}