Interface PlaceAssetQueryOptions

Mapping of available query parameters for the assets index endpoint

interface PlaceAssetQueryOptions {
    _poll?: boolean;
    barcode?: string;
    cache?: number;
    fields?: string;
    limit?: number;
    offset?: number;
    order_id?: string;
    q?: string;
    ref?: string;
    serial_number?: string;
    type_id?: string;
    zone_id?: string;
}

Hierarchy (View Summary)

Properties

_poll? barcode? cache? fields? limit? offset? order_id? q? ref? serial_number? type_id? zone_id?

Properties

Optional_poll

_poll?: boolean

Whether the request is a API poll request

Optionalbarcode

barcode?: string

Return assets that have a matching barcode

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)

Optionallimit

limit?: number

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

Optionaloffset

offset?: number

Offset of the results to return. Max 1000000

Optionalorder_id

order_id?: string

Return assets that match the purchase order ID provided

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

Optionalserial_number

serial_number?: string

Return assets that have a matching serial number

Optionaltype_id

type_id?: string

Return assets that match the asset type ID provided

Optionalzone_id

zone_id?: string

Return assets which are in the zone provided

Settings

Member Visibility

On This Page

Properties