Function CronJobApiFactory

CronJobApi - factory interface

Export

CronJobApiFactory(configuration?, basePath?, axios?): {
    cronJobControllerCreate(cronJobCreateDTO?: CronJobCreateDTO, options?: RawAxiosRequestConfig): AxiosPromise<CronJobOutputDTOAPI>;
    cronJobControllerGetExecutions(id: string, success?: any, eventSearchInputDTO?: EventSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventOutputArrayDTOAPI>;
    cronJobControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CronJobOutputDTOAPI>;
    cronJobControllerRemove(id: string, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
    cronJobControllerSearch(cronJobSearchInputDTO?: CronJobSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<CronJobOutputArrayDTOAPI>;
    cronJobControllerTrigger(cronJobTriggerDTO?: CronJobTriggerDTO, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    cronJobControllerUpdate(id: string, cronJobUpdateDTO?: CronJobUpdateDTO, options?: RawAxiosRequestConfig): AxiosPromise<CronJobOutputDTOAPI>;
}
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    cronJobControllerCreate(cronJobCreateDTO?: CronJobCreateDTO, options?: RawAxiosRequestConfig): AxiosPromise<CronJobOutputDTOAPI>;
    cronJobControllerGetExecutions(id: string, success?: any, eventSearchInputDTO?: EventSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventOutputArrayDTOAPI>;
    cronJobControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<CronJobOutputDTOAPI>;
    cronJobControllerRemove(id: string, options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>;
    cronJobControllerSearch(cronJobSearchInputDTO?: CronJobSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<CronJobOutputArrayDTOAPI>;
    cronJobControllerTrigger(cronJobTriggerDTO?: CronJobTriggerDTO, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    cronJobControllerUpdate(id: string, cronJobUpdateDTO?: CronJobUpdateDTO, options?: RawAxiosRequestConfig): AxiosPromise<CronJobOutputDTOAPI>;
}
- cronJobControllerCreate:function
  - cronJobControllerCreate(cronJobCreateDTO?, options?): AxiosPromise<CronJobOutputDTOAPI>
  - Required permissions: MANAGE_MODULES
    Parameters
    - OptionalcronJobCreateDTO: CronJobCreateDTO
      CronJobCreateDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CronJobOutputDTOAPI>
    Summary
    Create
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:11051
- cronJobControllerGetExecutions:function
  - cronJobControllerGetExecutions(id, success?, eventSearchInputDTO?, options?): AxiosPromise<EventOutputArrayDTOAPI>
  - Required permissions: READ_MODULES
    Parameters
    - id: string
    - Optionalsuccess: any
    - OptionaleventSearchInputDTO: EventSearchInputDTO
      EventSearchInputDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<EventOutputArrayDTOAPI>
    Summary
    Get executions
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:11066
- cronJobControllerGetOne:function
  - cronJobControllerGetOne(id, options?): AxiosPromise<CronJobOutputDTOAPI>
  - Required permissions: READ_MODULES
    Parameters
    - id: string
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CronJobOutputDTOAPI>
    Summary
    Get one
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:11083
- cronJobControllerRemove:function
  - cronJobControllerRemove(id, options?): AxiosPromise<APIOutput>
  - Required permissions: MANAGE_MODULES
    Parameters
    - id: string
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<APIOutput>
    Summary
    Remove
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:11093
- cronJobControllerSearch:function
  - cronJobControllerSearch(cronJobSearchInputDTO?, options?): AxiosPromise<CronJobOutputArrayDTOAPI>
  - Required permissions: READ_MODULES
    Parameters
    - OptionalcronJobSearchInputDTO: CronJobSearchInputDTO
      CronJobSearchInputDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CronJobOutputArrayDTOAPI>
    Summary
    Search
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:11103
- cronJobControllerTrigger:function
  - cronJobControllerTrigger(cronJobTriggerDTO?, options?): AxiosPromise<void>
  - Required permissions: MANAGE_MODULES
    Parameters
    - OptionalcronJobTriggerDTO: CronJobTriggerDTO
      CronJobTriggerDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<void>
    Summary
    Trigger
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:11118
- cronJobControllerUpdate:function
  - cronJobControllerUpdate(id, cronJobUpdateDTO?, options?): AxiosPromise<CronJobOutputDTOAPI>
  - Required permissions: MANAGE_MODULES
    Parameters
    - id: string
    - OptionalcronJobUpdateDTO: CronJobUpdateDTO
      CronJobUpdateDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CronJobOutputDTOAPI>
    Summary
    Update
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:11134
- Defined in packages/lib-apiclient/src/generated/api.ts:11041

Function CronJobApiFactory

Export

Parameters

cronJobControllerCreate:function

Parameters

Returns AxiosPromise<CronJobOutputDTOAPI>

Summary

Throws

cronJobControllerGetExecutions:function

Parameters

Returns AxiosPromise<EventOutputArrayDTOAPI>

Summary

Throws

cronJobControllerGetOne:function

Parameters

Returns AxiosPromise<CronJobOutputDTOAPI>

Summary

Throws

cronJobControllerRemove:function

Parameters

Returns AxiosPromise<APIOutput>

Summary

Throws

cronJobControllerSearch:function

Parameters

Returns AxiosPromise<CronJobOutputArrayDTOAPI>

Summary

Throws

cronJobControllerTrigger:function

Parameters

Returns AxiosPromise<void>

Summary

Throws

cronJobControllerUpdate:function

Parameters

Returns AxiosPromise<CronJobOutputDTOAPI>

Summary

Throws

Settings