Class TimeSeriesApi

Hierarchy (view full)

Constructors

constructor

Properties

configuration

Methods

deleteTimeSeriesProfileInstanceWithLocationIdWithParameterIdWithVersion deleteTimeSeriesProfileInstanceWithLocationIdWithParameterIdWithVersionRaw deleteTimeSeriesProfileParserWithLocationIdWithParameterId deleteTimeSeriesProfileParserWithLocationIdWithParameterIdRaw deleteTimeSeriesProfileWithLocationIdWithParameterId deleteTimeSeriesProfileWithLocationIdWithParameterIdRaw deleteTimeSeriesWithTimeSeries deleteTimeSeriesWithTimeSeriesRaw getTimeSeries getTimeSeriesFiltered getTimeSeriesFilteredRaw getTimeSeriesProfile getTimeSeriesProfileInstance getTimeSeriesProfileInstanceRaw getTimeSeriesProfileInstanceWithLocationIdWithParameterIdWithVersion getTimeSeriesProfileInstanceWithLocationIdWithParameterIdWithVersionRaw getTimeSeriesProfileParser getTimeSeriesProfileParserRaw getTimeSeriesProfileParserWithLocationIdWithParameterId getTimeSeriesProfileParserWithLocationIdWithParameterIdRaw getTimeSeriesProfileRaw getTimeSeriesProfileWithLocationIdWithParameterId getTimeSeriesProfileWithLocationIdWithParameterIdRaw getTimeSeriesRaw getTimeSeriesRecent getTimeSeriesRecentRaw patchTimeSeriesWithTimeSeries patchTimeSeriesWithTimeSeriesRaw postTimeSeries postTimeSeriesProfile postTimeSeriesProfileInstance postTimeSeriesProfileInstanceRaw postTimeSeriesProfileParser postTimeSeriesProfileParserRaw postTimeSeriesProfileRaw postTimeSeriesRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = ...

Methods

deleteTimeSeriesProfileInstanceWithLocationIdWithParameterIdWithVersion

deleteTimeSeriesProfileInstanceWithLocationIdWithParameterIdWithVersionRaw

deleteTimeSeriesProfileParserWithLocationIdWithParameterId

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

  • Delete a TimeSeriesProfile Parser by ID

    Parameters

    Returns Promise<void>

deleteTimeSeriesProfileParserWithLocationIdWithParameterIdRaw

deleteTimeSeriesProfileWithLocationIdWithParameterId

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

  • Delete a time series profile

    Parameters

    Returns Promise<void>

deleteTimeSeriesProfileWithLocationIdWithParameterIdRaw

deleteTimeSeriesWithTimeSeries

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

  • Delete timeseries with timeseries

    Parameters

    Returns Promise<void>

deleteTimeSeriesWithTimeSeriesRaw

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

  • Delete timeseries with timeseries

    Parameters

    Returns Promise<ApiResponse<void>>

getTimeSeries

  • getTimeSeries(requestParameters, initOverrides?): Promise<TimeSeries>

  • Get timeseries

    Parameters

    Returns Promise<TimeSeries>

getTimeSeriesFiltered

  • getTimeSeriesFiltered(requestParameters, initOverrides?): Promise<TimeSeries>

  • Get timeseries filtered

    Parameters

    Returns Promise<TimeSeries>

getTimeSeriesFilteredRaw

getTimeSeriesProfile

getTimeSeriesProfileInstance

  • getTimeSeriesProfileInstance(requestParameters?, initOverrides?): Promise<TimeSeriesProfileInstance>

  • Get all time series profile instances that match the provided masks. This endpoint will return a list of time series profile instances without the associated data. Data for an instance can be retrieved using the singular retrieval endpoint.

    Parameters

    Returns Promise<TimeSeriesProfileInstance>

getTimeSeriesProfileInstanceRaw

  • getTimeSeriesProfileInstanceRaw(requestParameters, initOverrides?): Promise<ApiResponse<TimeSeriesProfileInstance>>

  • Get all time series profile instances that match the provided masks. This endpoint will return a list of time series profile instances without the associated data. Data for an instance can be retrieved using the singular retrieval endpoint.

    Parameters

    Returns Promise<ApiResponse<TimeSeriesProfileInstance>>

getTimeSeriesProfileInstanceWithLocationIdWithParameterIdWithVersion

getTimeSeriesProfileInstanceWithLocationIdWithParameterIdWithVersionRaw

getTimeSeriesProfileParser

getTimeSeriesProfileParserRaw

getTimeSeriesProfileParserWithLocationIdWithParameterId

getTimeSeriesProfileParserWithLocationIdWithParameterIdRaw

getTimeSeriesProfileRaw

getTimeSeriesProfileWithLocationIdWithParameterId

getTimeSeriesProfileWithLocationIdWithParameterIdRaw

getTimeSeriesRaw

getTimeSeriesRecent

  • getTimeSeriesRecent(requestParameters?, initOverrides?): Promise<Tsv[]>

  • Returns CWMS TimeSeries Groups Data Get timeseries recent

    Parameters

    Returns Promise<Tsv[]>

getTimeSeriesRecentRaw

  • getTimeSeriesRecentRaw(requestParameters, initOverrides?): Promise<ApiResponse<Tsv[]>>

  • Returns CWMS TimeSeries Groups Data Get timeseries recent

    Parameters

    Returns Promise<ApiResponse<Tsv[]>>

patchTimeSeriesWithTimeSeries

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

  • Update a TimeSeries with provided values Patch timeseries with timeseries

    Parameters

    Returns Promise<void>

patchTimeSeriesWithTimeSeriesRaw

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

  • Update a TimeSeries with provided values Patch timeseries with timeseries

    Parameters

    Returns Promise<ApiResponse<void>>

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. If data entry date is included in the request, it will be dropped. Post timeseries

    Parameters

    Returns Promise<void>

postTimeSeriesProfile

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

  • Create a new time series profile

    Parameters

    Returns Promise<void>

postTimeSeriesProfileInstance

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

  • Create a new time series profile instance by parsing provided data

    Parameters

    Returns Promise<void>

postTimeSeriesProfileInstanceRaw

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

  • Create a new time series profile instance by parsing provided data

    Parameters

    Returns Promise<ApiResponse<void>>

postTimeSeriesProfileParser

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

  • Store a TimeSeriesProfile Parser

    Parameters

    Returns Promise<void>

postTimeSeriesProfileParserRaw

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

  • Store a TimeSeriesProfile Parser

    Parameters

    Returns Promise<ApiResponse<void>>

postTimeSeriesProfileRaw

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

  • Create a new time series profile

    Parameters

    Returns Promise<ApiResponse<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. If data entry date is included in the request, it will be dropped. Post timeseries

    Parameters

    Returns Promise<ApiResponse<void>>

Protected request

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

  • Parameters

    • context: RequestOpts
    • Optional initOverrides: RequestInit

    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

constructorconfigurationdeleteTimeSeriesProfileInstanceWithLocationIdWithParameterIdWithVersiondeleteTimeSeriesProfileInstanceWithLocationIdWithParameterIdWithVersionRawdeleteTimeSeriesProfileParserWithLocationIdWithParameterIddeleteTimeSeriesProfileParserWithLocationIdWithParameterIdRawdeleteTimeSeriesProfileWithLocationIdWithParameterIddeleteTimeSeriesProfileWithLocationIdWithParameterIdRawdeleteTimeSeriesWithTimeSeriesdeleteTimeSeriesWithTimeSeriesRawgetTimeSeriesgetTimeSeriesFilteredgetTimeSeriesFilteredRawgetTimeSeriesProfilegetTimeSeriesProfileInstancegetTimeSeriesProfileInstanceRawgetTimeSeriesProfileInstanceWithLocationIdWithParameterIdWithVersiongetTimeSeriesProfileInstanceWithLocationIdWithParameterIdWithVersionRawgetTimeSeriesProfileParsergetTimeSeriesProfileParserRawgetTimeSeriesProfileParserWithLocationIdWithParameterIdgetTimeSeriesProfileParserWithLocationIdWithParameterIdRawgetTimeSeriesProfileRawgetTimeSeriesProfileWithLocationIdWithParameterIdgetTimeSeriesProfileWithLocationIdWithParameterIdRawgetTimeSeriesRawgetTimeSeriesRecentgetTimeSeriesRecentRawpatchTimeSeriesWithTimeSeriespatchTimeSeriesWithTimeSeriesRawpostTimeSeriespostTimeSeriesProfilepostTimeSeriesProfileInstancepostTimeSeriesProfileInstanceRawpostTimeSeriesProfileParserpostTimeSeriesProfileParserRawpostTimeSeriesProfileRawpostTimeSeriesRawrequestwithMiddlewarewithPostMiddlewarewithPreMiddleware