Class EventApi

EventApi - object-oriented interface

Export

EventApi

Hierarchy

BaseAPI
- EventApi

Index

Constructors

constructor

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

eventControllerCreate

eventControllerCreate(eventCreateDTO?, options?): Promise<AxiosResponse<EventOutputDTO, any>>
Required permissions: MANAGE_EVENTS
Parameters
- OptionaleventCreateDTO: EventCreateDTO
  EventCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EventOutputDTO, any>>
Summary
Create

Throws
Memberof
EventApi
- Defined in packages/lib-apiclient/src/generated/api.ts:13145

eventControllerGetFailedFunctions

eventControllerGetFailedFunctions(eventSearchInputDTO?, options?): Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>
Fetches events where cronjob, hook and command failed. Supports all the common query parameters Required permissions: READ_MODULES, READ_EVENTS
Parameters
- OptionaleventSearchInputDTO: EventSearchInputDTO
  EventSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>
Summary
Get failed functions

Throws
Memberof
EventApi
- Defined in packages/lib-apiclient/src/generated/api.ts:13159

eventControllerGetOne

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

Throws
Memberof
EventApi
- Defined in packages/lib-apiclient/src/generated/api.ts:13173

eventControllerSearch

eventControllerSearch(eventSearchInputDTO?, options?): Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>
Required permissions: READ_EVENTS
Parameters
- OptionaleventSearchInputDTO: EventSearchInputDTO
  EventSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>
Summary
Search

Throws
Memberof
EventApi
- Defined in packages/lib-apiclient/src/generated/api.ts:13187

Class EventApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EventApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

eventControllerCreate

Parameters

Returns Promise<AxiosResponse<EventOutputDTO, any>>

Summary

Throws

Memberof

eventControllerGetFailedFunctions

Parameters

Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>

Summary

Throws

Memberof

eventControllerGetOne

Parameters

Returns Promise<AxiosResponse<EventOutputDTO, any>>

Summary

Throws

Memberof

eventControllerSearch

Parameters

Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration