Class EntityApi

Hierarchy (view full)

BaseAPI
- EntityApi

Index

Constructors

Properties

Methods

deleteEntityWithEntityId deleteEntityWithEntityIdRaw getEntity getEntityRaw getEntityWithEntityId getEntityWithEntityIdRaw patchEntityWithEntityId patchEntityWithEntityIdRaw postEntity postEntityRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteEntityWithEntityId

deleteEntityWithEntityId(requestParameters, initOverrides?): Promise<void>
Delete CWMS Entity. Delete entity with entityId
Parameters
- requestParameters: DeleteEntityWithEntityIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/EntityApi.ts:107

deleteEntityWithEntityIdRaw

deleteEntityWithEntityIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete CWMS Entity. Delete entity with entityId
Parameters
- requestParameters: DeleteEntityWithEntityIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/EntityApi.ts:64

getEntity

getEntity(requestParameters?, initOverrides?): Promise<Entity[]>
Returns all CWMS Entity Data filtered by optional masks. Get entity
Parameters
- requestParameters: GetEntityRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<Entity[]>
- Defined in cwmsjs/src/apis/EntityApi.ts:162

getEntityRaw

getEntityRaw(requestParameters, initOverrides?): Promise<ApiResponse<Entity[]>>
Returns all CWMS Entity Data filtered by optional masks. Get entity
Parameters
- requestParameters: GetEntityRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Entity[]>>
- Defined in cwmsjs/src/apis/EntityApi.ts:115

getEntityWithEntityId

getEntityWithEntityId(requestParameters, initOverrides?): Promise<Entity>
Returns CWMS Entity data by entity id and office id. Get entity with entityId
Parameters
- requestParameters: GetEntityWithEntityIdRequest
- Optional initOverrides: RequestInit
Returns Promise<Entity>
- Defined in cwmsjs/src/apis/EntityApi.ts:206

getEntityWithEntityIdRaw

getEntityWithEntityIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<Entity>>
Returns CWMS Entity data by entity id and office id. Get entity with entityId
Parameters
- requestParameters: GetEntityWithEntityIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Entity>>
- Defined in cwmsjs/src/apis/EntityApi.ts:171

patchEntityWithEntityId

patchEntityWithEntityId(requestParameters, initOverrides?): Promise<void>
Update an existing Entity. Patch entity with entityId
Parameters
- requestParameters: PatchEntityWithEntityIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/EntityApi.ts:249

patchEntityWithEntityIdRaw

patchEntityWithEntityIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Update an existing Entity. Patch entity with entityId
Parameters
- requestParameters: PatchEntityWithEntityIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/EntityApi.ts:215

postEntity

postEntity(requestParameters, initOverrides?): Promise<void>
Create CWMS Entity Post entity
Parameters
- requestParameters: PostEntityRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/EntityApi.ts:287

postEntityRaw

postEntityRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create CWMS Entity Post entity
Parameters
- requestParameters: PostEntityRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/EntityApi.ts:257

`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