Interface RateInputTimeSeries

Export

RateInputTimeSeries

interface RateInputTimeSeries {
    endInclusive?: boolean;
    endTime: number;
    next?: boolean;
    outputUnit: string;
    previous?: boolean;
    ratingTime?: number;
    round?: boolean;
    startInclusive?: boolean;
    startTime: number;
    timeSeriesIds: string[];
    trim?: boolean;
    versionDate?: number;
}

Properties

endInclusive? endTime next? outputUnit previous? ratingTime? round? startInclusive? startTime timeSeriesIds trim? versionDate?

Properties

Optional endInclusive

endInclusive?: boolean

Specifies whether the time window ends on or before the specified time. Defaults to true;

Memberof

RateInputTimeSeries

endTime

endTime: number

The end of the time window to rate.Represents milliseconds since 1970-01-01 (Unix Epoch), always UTC.

Memberof

RateInputTimeSeries

Optional next

next?: boolean

Specifies whether to retrieve the earliest value after the end of the time window. Defaults to false.

Memberof

RateInputTimeSeries

outputUnit

outputUnit: string

The units of the output values

Memberof

RateInputTimeSeries

Optional previous

previous?: boolean

Specifies whether to retrieve the latest value before the start of the time window. Defaults to false.

Memberof

RateInputTimeSeries

Optional ratingTime

ratingTime?: number

A specific date/time to use as the "current time" of the rating. No ratings with a create date later than this will be used. Useful for performing historical ratings. If not specified or NULL, the current time is use.

Memberof

RateInputTimeSeries

Optional round

round?: boolean

A flag specifying whether to round the rated values according to the rounding spec contained in the rating specification. Defaults to false.

Memberof

RateInputTimeSeries

Optional startInclusive

startInclusive?: boolean

Specifies whether the time window starts on or after the specified time. Defaults to true.

Memberof

RateInputTimeSeries

startTime

startTime: number

The start of the time window to rate.Represents milliseconds since 1970-01-01 (Unix Epoch), always UTC.

Memberof

RateInputTimeSeries

timeSeriesIds

timeSeriesIds: string[]

Memberof

RateInputTimeSeries

Optional trim

trim?: boolean

Specifies whether to trim missing values from the ends of the retrieved time series. Defaults to false.

Memberof

RateInputTimeSeries

Optional versionDate

versionDate?: number

Specifies the version date of the retrieve time series. Represents milliseconds since 1970-01-01 (Unix Epoch), always UTC.

Memberof

RateInputTimeSeries

Settings

Member Visibility

Theme

On This Page

endInclusiveendTimenextoutputUnitpreviousratingTimeroundstartInclusivestartTimetimeSeriesIdstrimversionDate