@c8y/client
Version:
Client application programming interface to access the Cumulocity IoT-Platform REST services.
57 lines • 1.88 kB
TypeScript
/**
* This interface specifies all fragments which can be used
* to filter for specific measurement.
*/
export interface IMeasurementFilter {
/**
* The current page of the paginated results.
*/
currentPage?: number;
/**
* The managed object ID which the measurement is associated to.
*/
source?: number | string;
/**
* From which date the measurements should be gathered
*/
dateFrom?: string | Date;
/**
* To which date the measurements should be gathered
*/
dateTo?: string | Date;
/**
* Indicates how many entries of the collection shall be returned.
* The upper limit for one page is 2000 objects.
*/
pageSize?: number;
/**
* 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.
*/
revert?: boolean;
/**
* The type of measurement to search for.
*/
type?: string;
/**
* The specific series to search for.
*/
valueFragmentSeries?: string;
/**
* When set to true, the returned result will contain in the statistics object the total number of elements.
* Only applicable to range queries.
*/
valueFragmentType?: string;
/**
* When set to true, the returned result will contain in the statistics object the total number of pages.
* Only applicable to range queries.
*/
withTotalPages?: boolean;
/**
* 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;
}
//# sourceMappingURL=IMeasurementFilter.d.ts.map