Interface IMeasurementFilter

This interface specifies all fragments which can be used to filter for specific measurement.

interface IMeasurementFilter {
    currentPage?: number;
    dateFrom?: string | Date;
    dateTo?: string | Date;
    pageSize?: number;
    revert?: boolean;
    source?: string | number;
    type?: string;
    valueFragmentSeries?: string;
    valueFragmentType?: string;
    withTotalElements?: boolean;
    withTotalPages?: boolean;
}

Properties

currentPage?: number

The current page of the paginated results.

dateFrom?: string | Date

From which date the measurements should be gathered

dateTo?: string | Date

To which date the measurements should be gathered

pageSize?: number

Indicates how many entries of the collection shall be returned. The upper limit for one page is 2000 objects.

revert?: boolean

If you are using a range query (that is, at least one of the dateFrom or dateTo parameters is included in the request), then setting revert=true will sort the results by the newest measurements first. By default, the results are sorted by the oldest measurements first.

source?: string | number

The managed object ID which the measurement is associated to.

type?: string

The type of measurement to search for.

valueFragmentSeries?: string

The specific series to search for.

valueFragmentType?: string

When set to true, the returned result will contain in the statistics object the total number of elements. Only applicable to range queries.

withTotalElements?: boolean

When set to true, the returned result will contain in the statistics object the total number of elements. Only applicable to range queries.

withTotalPages?: boolean

When set to true, the returned result will contain in the statistics object the total number of pages. Only applicable to range queries.