Interface RestFilterInterface

The common fields every filter request contain.

interface RestFilterInterface {
    datasetIds: number[];
    limit: number;
    offset: number;
    radius: number;
    siteModelEntityIds: (number | "")[];
    sortBy: SortableField;
    sortOrder: SortOrder;
    step: number;
    x: number;
    xMax: number;
    xMin: number;
    y: number;
    yMax: number;
    yMin: number;
    z: number;
}

Properties

datasetIds limit offset radius siteModelEntityIds sortBy sortOrder step x xMax xMin y yMax yMin z

Properties

datasetIds

datasetIds: number[]

Select for items associated to given dataset IDs.

limit

limit: number

Limit the amount of items to retrieve.

offset

offset: number

Skip the specified number of items.

radius

radius: number

Distance from given y, x, and z to select items [m].

siteModelEntityIds

siteModelEntityIds: (number | "")[]

Select for items associated to given IDs. Pass a single-item array containing undefined to retrieve items with no Site Model Entity.

sortBy

sortBy: SortableField

Sort by given field.

sortOrder

sortOrder: SortOrder

Direction of sort priority.

step

step: number

Regularly subsample the list of items returned.

x

x: number

Select for items at or near X coordinate.

xMax

xMax: number

Bounding box upper X.

xMin

xMin: number

Bounding box lower X.

y

y: number

Select for items at or near Y coordinate.

yMax

yMax: number

Bounding box upper Y.

yMin

yMin: number

Bounding box lower Y.

z

z: number

Select for items at or near Z coordinate.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc