Interface SignageMediaQueryOptions

Allowable query parameters for signage media index endpoint

interface SignageMediaQueryOptions {
    _poll?: boolean;
    authority_id?: string;
    cache?: number;
    fields?: string;
    group_id?: string;
    item_id?: string;
    limit?: number;
    offset?: number;
    preview?: boolean;
    q?: string;
    ref?: string;
    tags?: string | string[];
}

Hierarchy (View Summary)

Properties

_poll? authority_id? cache? fields? group_id? item_id? limit? offset? preview? q? ref? tags?

Properties

Optional_poll

_poll?: boolean

Whether the request is a API poll request

Optionalauthority_id

authority_id?: string

ID of the authority to filter the returned values on

Optionalcache

cache?: number

Number of milliseconds to cache the query response

Optionalfields

fields?: string

Deprecated

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

Optionalgroup_id

group_id?: string

ID of the group to scope media to

Optionalitem_id

item_id?: string

ID of the currently playing item

Optionallimit

limit?: number

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

Optionaloffset

offset?: number

Offset of the results to return. Max 1000000

Optionalpreview

preview?: boolean

Ignore state changes to the display media is requested for

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

Optionaltags

tags?: string | string[]

Tags to filter media by

Settings

Member Visibility

On This Page

Properties