Class CronJobApi

CronJobApi - object-oriented interface

Export

CronJobApi

Hierarchy

BaseAPI
- CronJobApi

Index

Constructors

constructor

new CronJobApi(configuration?, basePath?, axios?): 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?, options?): Promise<AxiosResponse<CronJobOutputDTOAPI, any>>
Required permissions: MANAGE_MODULES
Parameters
- OptionalcronJobCreateDTO: CronJobCreateDTO
  CronJobCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CronJobOutputDTOAPI, any>>
Summary
Create

Throws
Memberof
CronJobApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11735

cronJobControllerGetExecutions

cronJobControllerGetExecutions(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
CronJobApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11751

cronJobControllerGetOne

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

Throws
Memberof
CronJobApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11770

cronJobControllerRemove

cronJobControllerRemove(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
CronJobApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11784

cronJobControllerSearch

cronJobControllerSearch(cronJobSearchInputDTO?, options?): Promise<AxiosResponse<CronJobOutputArrayDTOAPI, any>>
Required permissions: READ_MODULES
Parameters
- OptionalcronJobSearchInputDTO: CronJobSearchInputDTO
  CronJobSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CronJobOutputArrayDTOAPI, any>>
Summary
Search

Throws
Memberof
CronJobApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11798

cronJobControllerTrigger

cronJobControllerTrigger(cronJobTriggerDTO?, options?): Promise<AxiosResponse<void, any>>
Required permissions: MANAGE_MODULES
Parameters
- OptionalcronJobTriggerDTO: CronJobTriggerDTO
  CronJobTriggerDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Trigger

Throws
Memberof
CronJobApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11812

cronJobControllerUpdate

cronJobControllerUpdate(id, cronJobUpdateDTO?, options?): Promise<AxiosResponse<CronJobOutputDTOAPI, any>>
Required permissions: MANAGE_MODULES
Parameters
- id: string
- OptionalcronJobUpdateDTO: CronJobUpdateDTO
  CronJobUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CronJobOutputDTOAPI, any>>
Summary
Update

Throws
Memberof
CronJobApi
- Defined in packages/lib-apiclient/src/generated/api.ts:11827

Class CronJobApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CronJobApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

cronJobControllerCreate

Parameters

Returns Promise<AxiosResponse<CronJobOutputDTOAPI, any>>

Summary

Throws

Memberof

cronJobControllerGetExecutions

Parameters

Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>

Summary

Throws

Memberof

cronJobControllerGetOne

Parameters

Returns Promise<AxiosResponse<CronJobOutputDTOAPI, any>>

Summary

Throws

Memberof

cronJobControllerRemove

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Summary

Throws

Memberof

cronJobControllerSearch

Parameters

Returns Promise<AxiosResponse<CronJobOutputArrayDTOAPI, any>>

Summary

Throws

Memberof

cronJobControllerTrigger

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

cronJobControllerUpdate

Parameters

Returns Promise<AxiosResponse<CronJobOutputDTOAPI, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration