Class TimeSeriesGroupsApi

Hierarchy (view full)

Constructors

constructor

Properties

configuration

Methods

deleteTimeSeriesGroupWithGroupId deleteTimeSeriesGroupWithGroupIdRaw getTimeSeriesGroup getTimeSeriesGroupRaw getTimeSeriesGroupWithGroupId getTimeSeriesGroupWithGroupIdRaw patchTimeSeriesGroupWithGroupId patchTimeSeriesGroupWithGroupIdRaw postTimeSeriesGroup postTimeSeriesGroupRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = ...

Methods

deleteTimeSeriesGroupWithGroupId

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

  • Deletes requested time series group Delete timeseries group with groupId

    Parameters

    Returns Promise<void>

deleteTimeSeriesGroupWithGroupIdRaw

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

  • Deletes requested time series group Delete timeseries group with groupId

    Parameters

    Returns Promise<ApiResponse<void>>

getTimeSeriesGroup

  • getTimeSeriesGroup(requestParameters?, initOverrides?): Promise<TimeSeriesGroup[]>

  • Returns CWMS TimeSeries Groups Data Get timeseries group

    Parameters

    Returns Promise<TimeSeriesGroup[]>

getTimeSeriesGroupRaw

getTimeSeriesGroupWithGroupId

  • getTimeSeriesGroupWithGroupId(requestParameters, initOverrides?): Promise<TimeSeriesGroup>

  • Retrieves requested timeseries group Get timeseries group with groupId

    Parameters

    Returns Promise<TimeSeriesGroup>

getTimeSeriesGroupWithGroupIdRaw

patchTimeSeriesGroupWithGroupId

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

  • Update existing TimeSeriesGroup. Allows for renaming of the group, assigning new time series, and unassigning all time series from the group. Patch timeseries group with groupId

    Parameters

    Returns Promise<void>

patchTimeSeriesGroupWithGroupIdRaw

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

  • Update existing TimeSeriesGroup. Allows for renaming of the group, assigning new time series, and unassigning all time series from the group. Patch timeseries group with groupId

    Parameters

    Returns Promise<ApiResponse<void>>

postTimeSeriesGroup

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

  • Create new TimeSeriesGroup Post timeseries group

    Parameters

    Returns Promise<void>

postTimeSeriesGroupRaw

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

  • Create new TimeSeriesGroup Post timeseries group

    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

constructorconfigurationdeleteTimeSeriesGroupWithGroupIddeleteTimeSeriesGroupWithGroupIdRawgetTimeSeriesGroupgetTimeSeriesGroupRawgetTimeSeriesGroupWithGroupIdgetTimeSeriesGroupWithGroupIdRawpatchTimeSeriesGroupWithGroupIdpatchTimeSeriesGroupWithGroupIdRawpostTimeSeriesGrouppostTimeSeriesGroupRawrequestwithMiddlewarewithPostMiddlewarewithPreMiddleware