@c8y/client/lib/src/measurement/ISeriesFilter.d.ts

Client application programming interface to access the Cumulocity IoT-Platform REST services.

export declare enum aggregationType {
    MINUTELY = "MINUTELY",
    HOURLY = "HOURLY",
    DAILY = "DAILY"
}
/**
 * This interface specifies all fragments which can be used
 * to filter for specific series.
 */
export interface ISeriesFilter {
    /**
     * The ManagedObject which is the source of these series
     */
    source: number | string;
    /**
     * From which date the series should be gathered
     */
    dateFrom: string | Date;
    /**
     * To which date the series should be gathered
     */
    dateTo: string | Date;
    /**
     * For which aggregation it should filter, see [[aggregationType]]
     */
    aggregationType?: aggregationType;
    /**
     * The series type and name
     *
     * **Example**
     * ```typescript
     *
     * const series: string[] = ['c8y_AccelerationMeasurement.acceleration', '...'];
     * ```
     */
    series?: string | string[];
    /**
     * 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.
     *
     * Note: it will not sort a measurements by a date, but by the order of the measurements in the response.
     */
    revert?: boolean;
}
//# sourceMappingURL=ISeriesFilter.d.ts.map