Function EventApiFactory

EventApi - factory interface

Export

EventApiFactory(configuration?, basePath?, axios?): {
    eventControllerCreate(eventCreateDTO?: EventCreateDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventOutputDTO>;
    eventControllerGetFailedFunctions(eventSearchInputDTO?: EventSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventOutputArrayDTOAPI>;
    eventControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<EventOutputDTO>;
    eventControllerSearch(eventSearchInputDTO?: EventSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventOutputArrayDTOAPI>;
}
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    eventControllerCreate(eventCreateDTO?: EventCreateDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventOutputDTO>;
    eventControllerGetFailedFunctions(eventSearchInputDTO?: EventSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventOutputArrayDTOAPI>;
    eventControllerGetOne(id: string, options?: RawAxiosRequestConfig): AxiosPromise<EventOutputDTO>;
    eventControllerSearch(eventSearchInputDTO?: EventSearchInputDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventOutputArrayDTOAPI>;
}
- eventControllerCreate:function
  - eventControllerCreate(eventCreateDTO?, options?): AxiosPromise<EventOutputDTO>
  - Required permissions: MANAGE_EVENTS
    Parameters
    - OptionaleventCreateDTO: EventCreateDTO
      EventCreateDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<EventOutputDTO>
    Summary
    Create
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:13083
- eventControllerGetFailedFunctions:function
  - eventControllerGetFailedFunctions(eventSearchInputDTO?, options?): AxiosPromise<EventOutputArrayDTOAPI>
  - 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 AxiosPromise<EventOutputArrayDTOAPI>
    Summary
    Get failed functions
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:13096
- eventControllerGetOne:function
  - eventControllerGetOne(id, options?): AxiosPromise<EventOutputDTO>
  - Required permissions: READ_EVENTS
    Parameters
    - id: string
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<EventOutputDTO>
    Summary
    Get one
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:13111
- eventControllerSearch:function
  - eventControllerSearch(eventSearchInputDTO?, options?): AxiosPromise<EventOutputArrayDTOAPI>
  - Required permissions: READ_EVENTS
    Parameters
    - OptionaleventSearchInputDTO: EventSearchInputDTO
      EventSearchInputDTO
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<EventOutputArrayDTOAPI>
    Summary
    Search
    
    Throws
    - Defined in packages/lib-apiclient/src/generated/api.ts:13121
- Defined in packages/lib-apiclient/src/generated/api.ts:13073

Function EventApiFactory

Export

Parameters

eventControllerCreate:function

Parameters

Returns AxiosPromise<EventOutputDTO>

Summary

Throws

eventControllerGetFailedFunctions:function

Parameters

Returns AxiosPromise<EventOutputArrayDTOAPI>

Summary

Throws

eventControllerGetOne:function

Parameters

Returns AxiosPromise<EventOutputDTO>

Summary

Throws

eventControllerSearch:function

Parameters

Returns AxiosPromise<EventOutputArrayDTOAPI>

Summary

Throws

Settings