Class LocationGroupsApi

Hierarchy (view full)

Constructors

constructor

Properties

configuration

Methods

deleteLocationGroupWithGroupId deleteLocationGroupWithGroupIdRaw getLocationGroup getLocationGroupRaw getLocationGroupWithGroupId getLocationGroupWithGroupIdRaw patchLocationGroupWithGroupId patchLocationGroupWithGroupIdRaw postLocationGroup postLocationGroupRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = ...

Methods

deleteLocationGroupWithGroupId

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

  • Deletes requested location group Delete location group with groupId

    Parameters

    Returns Promise<void>

deleteLocationGroupWithGroupIdRaw

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

  • Deletes requested location group Delete location group with groupId

    Parameters

    Returns Promise<ApiResponse<void>>

getLocationGroup

  • getLocationGroup(requestParameters, initOverrides?): Promise<LocationGroup[]>

  • Returns CWMS Location Groups Data Get location group

    Parameters

    Returns Promise<LocationGroup[]>

getLocationGroupRaw

getLocationGroupWithGroupId

  • getLocationGroupWithGroupId(requestParameters, initOverrides?): Promise<LocationGroup>

  • Retrieves requested Location Group. This endpoint supports GEO JSON responses with application/geo+json.For more information about accept header usage, <a href="legacy-format/">see this page. Get location group with groupId

    Parameters

    Returns Promise<LocationGroup>

getLocationGroupWithGroupIdRaw

  • getLocationGroupWithGroupIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<LocationGroup>>

  • Retrieves requested Location Group. This endpoint supports GEO JSON responses with application/geo+json.For more information about accept header usage, <a href="legacy-format/">see this page. Get location group with groupId

    Parameters

    Returns Promise<ApiResponse<LocationGroup>>

patchLocationGroupWithGroupId

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

  • Update existing LocationGroup. Allows for renaming group, assigning new locations, and unassigning all locations from the group. Patch location group with groupId

    Parameters

    Returns Promise<void>

patchLocationGroupWithGroupIdRaw

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

  • Update existing LocationGroup. Allows for renaming group, assigning new locations, and unassigning all locations from the group. Patch location group with groupId

    Parameters

    Returns Promise<ApiResponse<void>>

postLocationGroup

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

  • Create new LocationGroup Post location group

    Parameters

    Returns Promise<void>

postLocationGroupRaw

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

  • Create new LocationGroup Post location 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

constructorconfigurationdeleteLocationGroupWithGroupIddeleteLocationGroupWithGroupIdRawgetLocationGroupgetLocationGroupRawgetLocationGroupWithGroupIdgetLocationGroupWithGroupIdRawpatchLocationGroupWithGroupIdpatchLocationGroupWithGroupIdRawpostLocationGrouppostLocationGroupRawrequestwithMiddlewarewithPostMiddlewarewithPreMiddleware