Class TimeSeriesIdentifierApi

Hierarchy (view full)

BaseAPI
- TimeSeriesIdentifierApi

Index

Constructors

Properties

Methods

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteTimeSeriesIdentifierDescriptorWithTimeseriesId

deleteTimeSeriesIdentifierDescriptorWithTimeseriesId(requestParameters, initOverrides?): Promise<void>
Deletes requested timeseries identifier Delete cwmsData timeseries identifierDescriptor with timeseriesId
Parameters
- requestParameters: DeleteTimeSeriesIdentifierDescriptorWithTimeseriesIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:128

deleteTimeSeriesIdentifierDescriptorWithTimeseriesIdRaw

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

getTimeSeriesIdentifierDescriptor

getTimeSeriesIdentifierDescriptor(requestParameters?, initOverrides?): Promise<TimeSeriesIdentifierDescriptors>
Returns CWMS timeseries identifier descriptorData Get cwmsData timeseries identifierDescriptor
Parameters
- requestParameters: GetTimeSeriesIdentifierDescriptorRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<TimeSeriesIdentifierDescriptors>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:171

getTimeSeriesIdentifierDescriptorRaw

getTimeSeriesIdentifierDescriptorRaw(requestParameters, initOverrides?): Promise<ApiResponse<TimeSeriesIdentifierDescriptors>>
Returns CWMS timeseries identifier descriptorData Get cwmsData timeseries identifierDescriptor
Parameters
- requestParameters: GetTimeSeriesIdentifierDescriptorRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<TimeSeriesIdentifierDescriptors>>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:136

getTimeSeriesIdentifierDescriptorWithTimeseriesId

getTimeSeriesIdentifierDescriptorWithTimeseriesId(requestParameters, initOverrides?): Promise<TimeSeriesIdentifierDescriptor>
Retrieves requested timeseries identifier descriptor Get cwmsData timeseries identifierDescriptor with timeseriesId
Parameters
- requestParameters: GetTimeSeriesIdentifierDescriptorWithTimeseriesIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<TimeSeriesIdentifierDescriptor>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:217

getTimeSeriesIdentifierDescriptorWithTimeseriesIdRaw

getTimeSeriesIdentifierDescriptorWithTimeseriesIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<TimeSeriesIdentifierDescriptor>>
Retrieves requested timeseries identifier descriptor Get cwmsData timeseries identifierDescriptor with timeseriesId
Parameters
- requestParameters: GetTimeSeriesIdentifierDescriptorWithTimeseriesIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<TimeSeriesIdentifierDescriptor>>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:180

`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.
Inherited from BaseAPI.isJsonMime
- Defined in cwmsjs/src/runtime.ts:127

patchTimeSeriesIdentifierDescriptorWithTimeseriesId

patchTimeSeriesIdentifierDescriptorWithTimeseriesId(requestParameters, initOverrides?): Promise<void>
Patch cwmsData timeseries identifierDescriptor with timeseriesId
Parameters
- requestParameters: PatchTimeSeriesIdentifierDescriptorWithTimeseriesIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:292

patchTimeSeriesIdentifierDescriptorWithTimeseriesIdRaw

patchTimeSeriesIdentifierDescriptorWithTimeseriesIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Patch cwmsData timeseries identifierDescriptor with timeseriesId
Parameters
- requestParameters: PatchTimeSeriesIdentifierDescriptorWithTimeseriesIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/TimeSeriesIdentifierApi.ts:225

postTimeSeriesIdentifierDescriptor

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

postTimeSeriesIdentifierDescriptorRaw

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

`Protected` request

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

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:101

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:112

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:107

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>>

Protected isJsonMime

Parameters

Returns boolean

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` isJsonMime

`Protected` request