Class TimeSeriesIdentifierApi

Hierarchy (view full)

BaseAPI
- TimeSeriesIdentifierApi

Index

Constructors

Properties

Methods

deleteTimeSeriesIdentifierDescriptorWithTimeSeriesId deleteTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw getTimeSeriesIdentifierDescriptor getTimeSeriesIdentifierDescriptorRaw getTimeSeriesIdentifierDescriptorWithTimeSeriesId getTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw patchTimeSeriesIdentifierDescriptorWithTimeSeriesId patchTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw postTimeSeriesIdentifierDescriptor postTimeSeriesIdentifierDescriptorRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new TimeSeriesIdentifierApi(configuration?): TimeSeriesIdentifierApi
Parameters
- configuration: Configuration = ...
Returns TimeSeriesIdentifierApi
Inherited from BaseAPI.constructor
- Defined in cwmsjs/src/runtime.ts:27

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteTimeSeriesIdentifierDescriptorWithTimeSeriesId

deleteTimeSeriesIdentifierDescriptorWithTimeSeriesId(requestParameters, initOverrides?): Promise<void>
Deletes requested timeseries identifier Delete timeseries identifierDescriptor with timeseriesId
Parameters
- requestParameters: DeleteTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:119

deleteTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw

deleteTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Deletes requested timeseries identifier Delete timeseries identifierDescriptor with timeseriesId
Parameters
- requestParameters: DeleteTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:76

getTimeSeriesIdentifierDescriptor

getTimeSeriesIdentifierDescriptor(requestParameters?, initOverrides?): Promise<TimeSeriesIdentifierDescriptors>
Returns CWMS timeseries identifier descriptorData. Currently includes aliased items in results. Get timeseries identifierDescriptor
Parameters
- requestParameters: GetTimeSeriesIdentifierDescriptorRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<TimeSeriesIdentifierDescriptors>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:170

getTimeSeriesIdentifierDescriptorRaw

getTimeSeriesIdentifierDescriptorRaw(requestParameters, initOverrides?): Promise<ApiResponse<TimeSeriesIdentifierDescriptors>>
Returns CWMS timeseries identifier descriptorData. Currently includes aliased items in results. Get timeseries identifierDescriptor
Parameters
- requestParameters: GetTimeSeriesIdentifierDescriptorRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<TimeSeriesIdentifierDescriptors>>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:127

getTimeSeriesIdentifierDescriptorWithTimeSeriesId

getTimeSeriesIdentifierDescriptorWithTimeSeriesId(requestParameters, initOverrides?): Promise<TimeSeriesIdentifierDescriptor>
Retrieves requested timeseries identifier descriptor Get timeseries identifierDescriptor with timeseriesId
Parameters
- requestParameters: GetTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest
- Optional initOverrides: RequestInit
Returns Promise<TimeSeriesIdentifierDescriptor>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:214

getTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw

getTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<TimeSeriesIdentifierDescriptor>>
Retrieves requested timeseries identifier descriptor Get timeseries identifierDescriptor with timeseriesId
Parameters
- requestParameters: GetTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<TimeSeriesIdentifierDescriptor>>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:179

patchTimeSeriesIdentifierDescriptorWithTimeSeriesId

patchTimeSeriesIdentifierDescriptorWithTimeSeriesId(requestParameters, initOverrides?): Promise<void>
Patch timeseries identifierDescriptor with timeseriesId
Parameters
- requestParameters: PatchTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:280

patchTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw

patchTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Patch timeseries identifierDescriptor with timeseriesId
Parameters
- requestParameters: PatchTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:222

postTimeSeriesIdentifierDescriptor

postTimeSeriesIdentifierDescriptor(requestParameters, initOverrides?): Promise<void>
Create new TimeSeriesIdentifierDescriptor Post timeseries identifierDescriptor
Parameters
- requestParameters: PostTimeSeriesIdentifierDescriptorRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:322

postTimeSeriesIdentifierDescriptorRaw

postTimeSeriesIdentifierDescriptorRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create new TimeSeriesIdentifierDescriptor Post timeseries identifierDescriptor
Parameters
- requestParameters: PostTimeSeriesIdentifierDescriptorRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:288

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in cwmsjs/src/runtime.ts:47

withMiddleware

withMiddleware<T>(this, ...middlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in cwmsjs/src/runtime.ts:31

withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in cwmsjs/src/runtime.ts:42

withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in cwmsjs/src/runtime.ts:37

Class TimeSeriesIdentifierApi

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TimeSeriesIdentifierApi

Properties

Protected configuration

Methods

deleteTimeSeriesIdentifierDescriptorWithTimeSeriesId

Parameters

Returns Promise<void>

deleteTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw

Parameters

Returns Promise<ApiResponse<void>>

getTimeSeriesIdentifierDescriptor

Parameters

Returns Promise<TimeSeriesIdentifierDescriptors>

getTimeSeriesIdentifierDescriptorRaw

Parameters

Returns Promise<ApiResponse<TimeSeriesIdentifierDescriptors>>

getTimeSeriesIdentifierDescriptorWithTimeSeriesId

Parameters

Returns Promise<TimeSeriesIdentifierDescriptor>

getTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw

Parameters

Returns Promise<ApiResponse<TimeSeriesIdentifierDescriptor>>

patchTimeSeriesIdentifierDescriptorWithTimeSeriesId

Parameters

Returns Promise<void>

patchTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw

Parameters

Returns Promise<ApiResponse<void>>

postTimeSeriesIdentifierDescriptor

Parameters

Returns Promise<void>

postTimeSeriesIdentifierDescriptorRaw

Parameters

Returns Promise<ApiResponse<void>>

Protected request

Parameters

Returns Promise<Response>

withMiddleware

Type Parameters

Parameters

Returns T

withPostMiddleware

Type Parameters

Parameters

Returns T

withPreMiddleware

Type Parameters

Parameters

Returns T

Settings

Member Visibility

Theme

On This Page

`Protected` configuration

`Protected` request