Interface PlaceAssetTypeQueryOptions

Mapping of available query parameters for the asset types index endpoint

interface PlaceAssetTypeQueryOptions {
    _poll?: boolean;
    brand?: string;
    cache?: number;
    category_id?: string;
    fields?: string;
    limit?: number;
    model_number?: string;
    offset?: number;
    q?: string;
    ref?: string;
    zone_id?: string;
}

Hierarchy (View Summary)

Properties

_poll? brand? cache? category_id? fields? limit? model_number? offset? q? ref? zone_id?

Properties

Optional_poll

_poll?: boolean

Whether the request is a API poll request

Optionalbrand

brand?: string

Return assets with the provided brand name

Optionalcache

cache?: number

Number of milliseconds to cache the query response

Optionalcategory_id

category_id?: string

Return asset types in the category provided

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

Optionalmodel_number

model_number?: string

Return assets with the provided model number

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

Optionalzone_id

zone_id?: string

Filters the asset count to the zone provided

Settings

Member Visibility

On This Page

Properties