Interface
Query object for running a query.
Properties
| Property | Type | Notes |
|---|---|---|
displayNames | string[] | List of display names for the 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: |
hasLocation | boolean | Indicates whether jobs with defined locations are returned. |
num | number | The number of results to return. |
q | string | The query for the search. The |
search | string | The match criteria for a simple search. The |
searchId | string | The id of a saved search. |
sortFields | SortField[] | Sort the results by certain fields. |
spatialExtent | string | Spatial extent string to filter jobs by their locations. |
start | 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.
q
q: stringThe query for the search. The q or search property must be specified when running a query.
search
search: stringThe match criteria for a simple search. The q or search property must be specified when running a query.
sortFields
sortFields: SortField[]Sort the results by certain fields.