Class VariableApi

VariableApi - object-oriented interface

Export

VariableApi

Hierarchy

BaseAPI
- VariableApi

Index

Constructors

constructor

new VariableApi(configuration?, basePath?, axios?): VariableApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns VariableApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

variableControllerCreate

variableControllerCreate(variableCreateDTO?, options?): Promise<AxiosResponse<VariableOutputDTOAPI, any>>
Required permissions: MANAGE_VARIABLES
Parameters
- OptionalvariableCreateDTO: VariableCreateDTO
  VariableCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<VariableOutputDTOAPI, any>>
Summary
Create

Throws
Memberof
VariableApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24698

variableControllerDelete

variableControllerDelete(id, options?): Promise<AxiosResponse<APIOutput, any>>
Required permissions: MANAGE_VARIABLES
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Delete

Throws
Memberof
VariableApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24712

variableControllerFindOne

variableControllerFindOne(id, options?): Promise<AxiosResponse<VariableOutputDTOAPI, any>>
Required permissions: READ_VARIABLES
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<VariableOutputDTOAPI, any>>
Summary
Find one

Throws
Memberof
VariableApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24726

variableControllerSearch

variableControllerSearch(variableSearchInputDTO?, options?): Promise<AxiosResponse<VariableOutputArrayDTOAPI, any>>
Required permissions: READ_VARIABLES
Parameters
- OptionalvariableSearchInputDTO: VariableSearchInputDTO
  VariableSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<VariableOutputArrayDTOAPI, any>>
Summary
Search

Throws
Memberof
VariableApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24740

variableControllerUpdate

variableControllerUpdate(id, variableUpdateDTO?, options?): Promise<AxiosResponse<VariableOutputDTOAPI, any>>
Required permissions: MANAGE_VARIABLES
Parameters
- id: string
- OptionalvariableUpdateDTO: VariableUpdateDTO
  VariableUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<VariableOutputDTOAPI, any>>
Summary
Update

Throws
Memberof
VariableApi
- Defined in packages/lib-apiclient/src/generated/api.ts:24755

Class VariableApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VariableApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

variableControllerCreate

Parameters

Returns Promise<AxiosResponse<VariableOutputDTOAPI, any>>

Summary

Throws

Memberof

variableControllerDelete

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Summary

Throws

Memberof

variableControllerFindOne

Parameters

Returns Promise<AxiosResponse<VariableOutputDTOAPI, any>>

Summary

Throws

Memberof

variableControllerSearch

Parameters

Returns Promise<AxiosResponse<VariableOutputArrayDTOAPI, any>>

Summary

Throws

Memberof

variableControllerUpdate

Parameters

Returns Promise<AxiosResponse<VariableOutputDTOAPI, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration