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? dateFrom? dateTo? pageSize? revert? source? type? valueFragmentSeries? valueFragmentType? withTotalElements? withTotalPages?

Properties

OptionalcurrentPage

currentPage?: number

The current page of the paginated results.

OptionaldateFrom

dateFrom?: string | Date

From which date the measurements should be gathered

OptionaldateTo

dateTo?: string | Date

To which date the measurements should be gathered

OptionalpageSize

pageSize?: number

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

Optionalrevert

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.

Optionalsource

source?: string | number

The managed object ID which the measurement is associated to.

Optionaltype

type?: string

The type of measurement to search for.

OptionalvalueFragmentSeries

valueFragmentSeries?: string

The specific series to search for.

OptionalvalueFragmentType

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.

OptionalwithTotalElements

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.

OptionalwithTotalPages

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.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR