Interface PlaceModuleQueryOptions

Mapping of available query parameters for the modules index endpoint

interface PlaceModuleQueryOptions {
    _poll?: boolean;
    as_of?: number;
    cache?: number;
    connected?: boolean;
    control_system_id?: string;
    driver_id?: string;
    fields?: string;
    limit?: number;
    no_logic?: boolean;
    offset?: number;
    q?: string;
    ref?: string;
    running?: boolean;
}

Hierarchy (View Summary)

Properties

_poll? as_of? cache? connected? control_system_id? driver_id? fields? limit? no_logic? offset? q? ref? running?

Properties

Optional_poll

_poll?: boolean

Whether the request is a API poll request

Optionalas_of

as_of?: number

Only return modules updated before this time (unix epoch)

Optionalcache

cache?: number

Number of milliseconds to cache the query response

Optionalconnected

connected?: boolean

Return results that connected state matches this value

Optionalcontrol_system_id

control_system_id?: string

Only return modules running in this system (query params are ignored if this is provided)

Optionaldriver_id

driver_id?: string

Only return instances of this driver

Optionalfields

fields?: string

Deprecated

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

Optionallimit

limit?: number

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

Optionalno_logic

no_logic?: boolean

Do not return logic modules (return only modules that can exist in multiple systems)

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

Optionalrunning

running?: boolean

Return only running modules

Settings

Member Visibility

On This Page

Properties