Interface PlaceModuleQueryOptions

Mapping of available query paramters for the modules index

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;
    running?: boolean;
}

Hierarchy

  • PlaceResourceQueryOptions
    • PlaceModuleQueryOptions

Properties

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

Properties

Optional_poll

_poll?: boolean

Whether the request is a API poll request

Optionalas_of

as_of?: number

Returns modules that have not been updated since the value defined as seconds since UTC 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

Returns modules that are in the given system

Optionaldriver_id

driver_id?: string

Returns modules with the given dependency

Optionalfields

fields?: string

Comma seperated list of fields to apply the query to

Optionallimit

limit?: number

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

Optionalno_logic

no_logic?: boolean

Returns modules that are not logic modules (i.e. they connect to a device or service)

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

Optionalrunning

running?: boolean

Return modules that are running or not stopped

Settings

Member Visibility

On This Page

Properties