Class TimeSeriesGroupsApi

Hierarchy (view full)

Constructors

constructor

Properties

configuration

Methods

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

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = DefaultConfig

Methods

deleteTimeSeriesGroupWithGroupId

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

  • Deletes requested time series group Delete cwmsData timeseries group with groupId

    Parameters

    Returns Promise<void>

deleteTimeSeriesGroupWithGroupIdRaw

getTimeSeriesGroup

getTimeSeriesGroupRaw

getTimeSeriesGroupWithGroupId

getTimeSeriesGroupWithGroupIdRaw

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.

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 cwmsData 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 cwmsData timeseries group with groupId

    Parameters

    Returns Promise<ApiResponse<void>>

postTimeSeriesGroup

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

  • Create new TimeSeriesGroup Post cwmsData timeseries group

    Parameters

    Returns Promise<void>

postTimeSeriesGroupRaw

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

  • Create new TimeSeriesGroup Post cwmsData timeseries group

    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

constructorconfigurationdeleteTimeSeriesGroupWithGroupIddeleteTimeSeriesGroupWithGroupIdRawgetTimeSeriesGroupgetTimeSeriesGroupRawgetTimeSeriesGroupWithGroupIdgetTimeSeriesGroupWithGroupIdRawisJsonMimepatchTimeSeriesGroupWithGroupIdpatchTimeSeriesGroupWithGroupIdRawpostTimeSeriesGrouppostTimeSeriesGroupRawrequestwithMiddlewarewithPostMiddlewarewithPreMiddleware