Interface PlaceSystemsQueryOptions

Allowable query parameters for systems index endpoint

interface PlaceSystemsQueryOptions {
    _poll?: boolean;
    cache?: number;
    fields?: string;
    in?: string;
    limit?: number;
    module_id?: string;
    offset?: number;
    q?: string;
    signage?: boolean;
    zone_id?: string;
}

Hierarchy

  • PlaceResourceQueryOptions
    • PlaceSystemsQueryOptions

Properties

_poll? cache? fields? in? limit? module_id? offset? q? signage? zone_id?

Properties

Optional_poll

_poll?: boolean

Whether the request is a API poll request

Optionalcache

cache?: number

Number of milliseconds to cache the query response

Optionalfields

fields?: string

Comma seperated list of fields to apply the query to

Optionalin

in?: string

Comma seperated list of email addresses to filter on

Optionallimit

limit?: number

Number of results to return. Defaults to 20. Max 500

Optionalmodule_id

module_id?: string

Driver ID to filter the returned values on

Optionaloffset

offset?: number

Offsets of the results to return. Max 10000

Optionalq

q?: string

Search filter supporting the following syntax https://www.elastic.co/guide/en/elasticsearch/reference/5.5/query-dsl-simple-query-string-query.html

Optionalsignage

signage?: boolean

Only return systems that have signage capabilities

Optionalzone_id

zone_id?: string

Zone ID to filter the returned values on

Settings

Member Visibility

On This Page

Properties