Interface
Query object for running a query.
Properties
| Property | Type | Notes |
|---|---|---|
string[] | List of display names for the fields. | |
string[] | List of fields whose value you want to return in the search result.
If no fields are defined in the search query, the following fields are returned by default: | |
boolean | Indicates whether jobs with defined locations are returned. | |
number | The number of results to return. | |
string | The query for the search. | |
string | The match criteria for a simple search. | |
string | ||
Sort the results by certain fields. | ||
string | Spatial extent string to filter jobs by their locations. | |
number | The index of the results from which you want to start the list of results |
fields
fields: string[]List of fields whose value you want to return in the search result.
If no fields are defined in the search query, the following fields are returned by default: jobName , priority , dueDate , currentStep .
hasLocation
hasLocation: booleanIndicates whether jobs with defined locations are returned.
sortFields
sortFields: SortField[]Sort the results by certain fields.