Class CronJobApi

CronJobApi - object-oriented interface

Export

CronJobApi

Hierarchy

BaseAPI
- CronJobApi

Index

Constructors

constructor

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

cronJobControllerCreate

cronJobControllerCreate(
cronJobCreateDTO?: CronJobCreateDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CronJobOutputDTOAPI>>
Required permissions: MANAGE_MODULES
OperationId: CronJobControllerCreate
Parameters
- OptionalcronJobCreateDTO: CronJobCreateDTO
  CronJobCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CronJobOutputDTOAPI>>
Throws
Memberof
CronJobApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11887

cronJobControllerGetExecutions

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

cronJobControllerGetOne

cronJobControllerGetOne(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CronJobOutputDTOAPI>>
Required permissions: READ_MODULES
OperationId: CronJobControllerGetOne
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CronJobOutputDTOAPI>>
Throws
Memberof
CronJobApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11922

cronJobControllerRemove

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

cronJobControllerSearch

cronJobControllerSearch(
cronJobSearchInputDTO?: CronJobSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CronJobOutputArrayDTOAPI>>
Required permissions: READ_MODULES
OperationId: CronJobControllerSearch
Parameters
- OptionalcronJobSearchInputDTO: CronJobSearchInputDTO
  CronJobSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CronJobOutputArrayDTOAPI>>
Throws
Memberof
CronJobApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11950

cronJobControllerTrigger

cronJobControllerTrigger(
cronJobTriggerDTO?: CronJobTriggerDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Required permissions: MANAGE_MODULES
OperationId: CronJobControllerTrigger
Parameters
- OptionalcronJobTriggerDTO: CronJobTriggerDTO
  CronJobTriggerDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
CronJobApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11964

cronJobControllerUpdate

cronJobControllerUpdate(
    id: string,
    cronJobUpdateDTO?: CronJobUpdateDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CronJobOutputDTOAPI>>
Required permissions: MANAGE_MODULES
OperationId: CronJobControllerUpdate
Parameters
- id: string
- OptionalcronJobUpdateDTO: CronJobUpdateDTO
  CronJobUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CronJobOutputDTOAPI>>
Throws
Memberof
CronJobApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11979

Class CronJobApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CronJobApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

cronJobControllerCreate

Parameters

Returns Promise<AxiosResponse<CronJobOutputDTOAPI>>

Throws

Memberof

cronJobControllerGetExecutions

Parameters

Returns Promise<AxiosResponse<EventOutputArrayDTOAPI>>

Throws

Memberof

cronJobControllerGetOne

Parameters

Returns Promise<AxiosResponse<CronJobOutputDTOAPI>>

Throws

Memberof

cronJobControllerRemove

Parameters

Returns Promise<AxiosResponse<APIOutput>>

Throws

Memberof

cronJobControllerSearch

Parameters

Returns Promise<AxiosResponse<CronJobOutputArrayDTOAPI>>

Throws

Memberof

cronJobControllerTrigger

Parameters

Returns Promise<AxiosResponse<void>>

Throws

Memberof

cronJobControllerUpdate

Parameters

Returns Promise<AxiosResponse<CronJobOutputDTOAPI>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration