Skip to content

Interface

Query object for running a query.

Properties

PropertyTypeNotes
displayNamesstring[]

List of display names for the fields.

fieldsstring[]

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 .

hasLocationboolean

Indicates whether jobs with defined locations are returned.

numnumber

The number of results to return.

qstring

The query for the search. The q or search property must be specified when running a query.

searchstring

The match criteria for a simple search. The q or search property must be specified when running a query.

searchIdstring

The id of a saved search.

sortFieldsSortField[]

Sort the results by certain fields.

spatialExtentstring

Spatial extent string to filter jobs by their locations.

startnumber

The index of the results from which you want to start the list of results

displayNames

optional
Interface Property

fields

optional
Interface Property

hasLocation

optional
Interface Property

num

optional
Interface Property

q

optional
Interface Property
optional
Interface Property

searchId

optional
Interface Property

sortFields

optional
Interface Property

spatialExtent

optional
Interface Property

start

Interface Property

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.