Class TimeSeriesApi

Hierarchy (view full)

Constructors

constructor

Properties

configuration

Methods

deleteTimeSeriesWithTimeseries deleteTimeSeriesWithTimeseriesRaw getTimeSeries getTimeSeriesRaw isJsonMime patchTimeSeriesWithTimeseries patchTimeSeriesWithTimeseriesRaw postTimeSeries postTimeSeriesRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = DefaultConfig

Methods

deleteTimeSeriesWithTimeseries

  • deleteTimeSeriesWithTimeseries(requestParameters, initOverrides?): Promise<void>

  • Delete cwmsData timeseries with timeseries

    Parameters

    Returns Promise<void>

deleteTimeSeriesWithTimeseriesRaw

getTimeSeries

getTimeSeriesRaw

Protected isJsonMime

  • isJsonMime(mime): boolean

  • Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json

    Parameters

    • mime: string

      MIME (Multipurpose Internet Mail Extensions)

    Returns boolean

    True if the given MIME is JSON, false otherwise.

patchTimeSeriesWithTimeseries

  • patchTimeSeriesWithTimeseries(requestParameters, initOverrides?): Promise<void>

  • Update a TimeSeries with provided values Patch cwmsData timeseries with timeseries

    Parameters

    Returns Promise<void>

patchTimeSeriesWithTimeseriesRaw

postTimeSeries

  • postTimeSeries(requestParameters, initOverrides?): Promise<void>

  • Used to create and save time-series data. Data to be stored must have time stamps in UTC represented as epoch milliseconds Post cwmsData timeseries

    Parameters

    Returns Promise<void>

postTimeSeriesRaw

  • postTimeSeriesRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

  • Used to create and save time-series data. Data to be stored must have time stamps in UTC represented as epoch milliseconds Post cwmsData timeseries

    Parameters

    Returns Promise<ApiResponse<void>>

Protected request

  • request(context, initOverrides?): Promise<Response>

  • Parameters

    Returns Promise<Response>

withMiddleware

withPostMiddleware

  • withPostMiddleware<T>(this, ...postMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]

    Returns T

withPreMiddleware

  • withPreMiddleware<T>(this, ...preMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]

    Returns T

Settings

Member Visibility

Theme

On This Page

constructorconfigurationdeleteTimeSeriesWithTimeseriesdeleteTimeSeriesWithTimeseriesRawgetTimeSeriesgetTimeSeriesRawisJsonMimepatchTimeSeriesWithTimeseriespatchTimeSeriesWithTimeseriesRawpostTimeSeriespostTimeSeriesRawrequestwithMiddlewarewithPostMiddlewarewithPreMiddleware