Class CommandApi

CommandApi - object-oriented interface

Export

CommandApi

Hierarchy

BaseAPI
- CommandApi

Index

Constructors

constructor

new CommandApi(configuration?, basePath?, axios?): CommandApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns CommandApi
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

commandControllerCreate

commandControllerCreate(commandCreateDTO?, options?): Promise<AxiosResponse<CommandOutputDTOAPI, any>>
Required permissions: MANAGE_MODULES
Parameters
- OptionalcommandCreateDTO: CommandCreateDTO
  CommandCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommandOutputDTOAPI, any>>
Summary
Create

Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:10429

commandControllerCreateArgument

commandControllerCreateArgument(commandArgumentCreateDTO?, options?): Promise<AxiosResponse<CommandArgumentDTOAPI, any>>
Required permissions: MANAGE_MODULES
Parameters
- OptionalcommandArgumentCreateDTO: CommandArgumentCreateDTO
  CommandArgumentCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommandArgumentDTOAPI, any>>
Summary
Create argument

Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:10443

commandControllerGetExecutions

commandControllerGetExecutions(id, success?, eventSearchInputDTO?, options?): Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>
Required permissions: READ_MODULES
Parameters
- id: string
- Optionalsuccess: any
- OptionaleventSearchInputDTO: EventSearchInputDTO
  EventSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>
Summary
Get executions

Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:10462

commandControllerGetOne

commandControllerGetOne(id, options?): Promise<AxiosResponse<CommandOutputDTOAPI, any>>
Required permissions: READ_MODULES
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommandOutputDTOAPI, any>>
Summary
Get one

Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:10481

commandControllerRemove

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

Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:10495

commandControllerRemoveArgument

commandControllerRemoveArgument(id, options?): Promise<AxiosResponse<APIOutput, any>>
Required permissions: MANAGE_MODULES
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Remove argument

Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:10509

commandControllerSearch

commandControllerSearch(commandSearchInputDTO?, options?): Promise<AxiosResponse<CommandOutputArrayDTOAPI, any>>
Required permissions: READ_MODULES
Parameters
- OptionalcommandSearchInputDTO: CommandSearchInputDTO
  CommandSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommandOutputArrayDTOAPI, any>>
Summary
Search

Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:10523

commandControllerTrigger

commandControllerTrigger(id, commandTriggerDTO?, options?): Promise<AxiosResponse<void, any>>
Required permissions: MANAGE_MODULES
Parameters
- id: string
- OptionalcommandTriggerDTO: CommandTriggerDTO
  CommandTriggerDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Trigger

Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:10538

commandControllerUpdate

commandControllerUpdate(id, commandUpdateDTO?, options?): Promise<AxiosResponse<CommandOutputDTOAPI, any>>
Required permissions: MANAGE_MODULES
Parameters
- id: string
- OptionalcommandUpdateDTO: CommandUpdateDTO
  CommandUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommandOutputDTOAPI, any>>
Summary
Update

Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:10553

commandControllerUpdateArgument

commandControllerUpdateArgument(id, commandArgumentUpdateDTO?, options?): Promise<AxiosResponse<CommandArgumentDTOAPI, any>>
Required permissions: MANAGE_MODULES
Parameters
- id: string
- OptionalcommandArgumentUpdateDTO: CommandArgumentUpdateDTO
  CommandArgumentUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommandArgumentDTOAPI, any>>
Summary
Update argument

Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:10568

Class CommandApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CommandApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

commandControllerCreate

Parameters

Returns Promise<AxiosResponse<CommandOutputDTOAPI, any>>

Summary

Throws

Memberof

commandControllerCreateArgument

Parameters

Returns Promise<AxiosResponse<CommandArgumentDTOAPI, any>>

Summary

Throws

Memberof

commandControllerGetExecutions

Parameters

Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>

Summary

Throws

Memberof

commandControllerGetOne

Parameters

Returns Promise<AxiosResponse<CommandOutputDTOAPI, any>>

Summary

Throws

Memberof

commandControllerRemove

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Summary

Throws

Memberof

commandControllerRemoveArgument

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Summary

Throws

Memberof

commandControllerSearch

Parameters

Returns Promise<AxiosResponse<CommandOutputArrayDTOAPI, any>>

Summary

Throws

Memberof

commandControllerTrigger

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

commandControllerUpdate

Parameters

Returns Promise<AxiosResponse<CommandOutputDTOAPI, any>>

Summary

Throws

Memberof

commandControllerUpdateArgument

Parameters

Returns Promise<AxiosResponse<CommandArgumentDTOAPI, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration