Interface PlaceSystemTriggersQueryOptions

Allowable query parameters for system triggers index endpoint

interface PlaceSystemTriggersQueryOptions {
    _poll?: boolean;
    as_of?: number;
    cache?: number;
    complete?: boolean;
    fields?: string;
    important?: boolean;
    limit?: number;
    offset?: number;
    q?: string;
    ref?: string;
    trigger_id?: string;
    triggered?: boolean;
}

Hierarchy (View Summary)

Properties

_poll? as_of? cache? complete? fields? important? limit? offset? q? ref? trigger_id? triggered?

Properties

Optional_poll

_poll?: boolean

Whether the request is a API poll request

Optionalas_of

as_of?: number

Return triggers updated before the time specified (unix epoch)

Optionalcache

cache?: number

Number of milliseconds to cache the query response

Optionalcomplete

complete?: boolean

Provide the control system details

Optionalfields

fields?: string

Deprecated

Ignored by the server since PlaceOS moved search to PostgreSQL (PPT-2644)

Optionalimportant

important?: boolean

Only return triggers marked as important

Optionallimit

limit?: number

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

Optionaloffset

offset?: number

Offset of the results to return. Max 1000000

Optionalq

q?: string

Free-text search filter. Words match as prefixes against the resource's searchable fields (PostgreSQL full-text search); all words must match.

Optionalref

ref?: string

Deprecated

Ignored by the server; pagination follows the Link header's offset

Optionaltrigger_id

trigger_id?: string

Filter by a particular trigger type

Optionaltriggered

triggered?: boolean

Only return triggers that have recently been triggered

Settings

Member Visibility

On This Page

Properties