Class CommandApi

CommandApi - object-oriented interface

Export

CommandApi

Hierarchy

BaseAPI
- CommandApi

Index

Constructors

constructor

new CommandApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): 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?: CommandCreateDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CommandOutputDTOAPI>>
Required permissions: MANAGE_MODULES
OperationId: CommandControllerCreate
Parameters
- OptionalcommandCreateDTO: CommandCreateDTO
  CommandCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommandOutputDTOAPI>>
Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11155

commandControllerCreateArgument

commandControllerCreateArgument(
commandArgumentCreateDTO?: CommandArgumentCreateDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CommandArgumentDTOAPI>>
Required permissions: MANAGE_MODULES
OperationId: CommandControllerCreateArgument
Parameters
- OptionalcommandArgumentCreateDTO: CommandArgumentCreateDTO
  CommandArgumentCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommandArgumentDTOAPI>>
Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11169

commandControllerGetExecutions

commandControllerGetExecutions(
    id: string,
    success?: any,
    eventSearchInputDTO?: EventSearchInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EventOutputArrayDTOAPI>>
Required permissions: READ_MODULES
OperationId: CommandControllerGetExecutions
Parameters
- id: string
- Optionalsuccess: any
- OptionaleventSearchInputDTO: EventSearchInputDTO
  EventSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EventOutputArrayDTOAPI>>
Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11188

commandControllerGetOne

commandControllerGetOne(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CommandOutputDTOAPI>>
Required permissions: READ_MODULES
OperationId: CommandControllerGetOne
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommandOutputDTOAPI>>
Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11207

commandControllerRemove

commandControllerRemove(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput>>
Required permissions: MANAGE_MODULES
OperationId: CommandControllerRemove
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput>>
Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11221

commandControllerRemoveArgument

commandControllerRemoveArgument(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput>>
Required permissions: MANAGE_MODULES
OperationId: CommandControllerRemoveArgument
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput>>
Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11235

commandControllerSearch

commandControllerSearch(
commandSearchInputDTO?: CommandSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CommandOutputArrayDTOAPI>>
Required permissions: READ_MODULES
OperationId: CommandControllerSearch
Parameters
- OptionalcommandSearchInputDTO: CommandSearchInputDTO
  CommandSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommandOutputArrayDTOAPI>>
Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11249

commandControllerTrigger

commandControllerTrigger(
    id: string,
    commandTriggerDTO?: CommandTriggerDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Required permissions: MANAGE_MODULES
OperationId: CommandControllerTrigger
Parameters
- id: string
- OptionalcommandTriggerDTO: CommandTriggerDTO
  CommandTriggerDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11264

commandControllerUpdate

commandControllerUpdate(
    id: string,
    commandUpdateDTO?: CommandUpdateDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CommandOutputDTOAPI>>
Required permissions: MANAGE_MODULES
OperationId: CommandControllerUpdate
Parameters
- id: string
- OptionalcommandUpdateDTO: CommandUpdateDTO
  CommandUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommandOutputDTOAPI>>
Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11279

commandControllerUpdateArgument

commandControllerUpdateArgument(
    id: string,
    commandArgumentUpdateDTO?: CommandArgumentUpdateDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CommandArgumentDTOAPI>>
Required permissions: MANAGE_MODULES
OperationId: CommandControllerUpdateArgument
Parameters
- id: string
- OptionalcommandArgumentUpdateDTO: CommandArgumentUpdateDTO
  CommandArgumentUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CommandArgumentDTOAPI>>
Throws
Memberof
CommandApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11294

Class CommandApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CommandApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

commandControllerCreate

Parameters

Returns Promise<AxiosResponse<CommandOutputDTOAPI>>

Throws

Memberof

commandControllerCreateArgument

Parameters

Returns Promise<AxiosResponse<CommandArgumentDTOAPI>>

Throws

Memberof

commandControllerGetExecutions

Parameters

Returns Promise<AxiosResponse<EventOutputArrayDTOAPI>>

Throws

Memberof

commandControllerGetOne

Parameters

Returns Promise<AxiosResponse<CommandOutputDTOAPI>>

Throws

Memberof

commandControllerRemove

Parameters

Returns Promise<AxiosResponse<APIOutput>>

Throws

Memberof

commandControllerRemoveArgument

Parameters

Returns Promise<AxiosResponse<APIOutput>>

Throws

Memberof

commandControllerSearch

Parameters

Returns Promise<AxiosResponse<CommandOutputArrayDTOAPI>>

Throws

Memberof

commandControllerTrigger

Parameters

Returns Promise<AxiosResponse<void>>

Throws

Memberof

commandControllerUpdate

Parameters

Returns Promise<AxiosResponse<CommandOutputDTOAPI>>

Throws

Memberof

commandControllerUpdateArgument

Parameters

Returns Promise<AxiosResponse<CommandArgumentDTOAPI>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration