Function EventApiFactory

Returns {
    eventControllerCreate(
        eventCreateDTO?: EventCreateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<EventOutputDTO>;
    eventControllerExport(
        eventSearchInputDTO?: EventSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    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?: EventCreateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<EventOutputDTO>

    Required permissions: MANAGE_EVENTS
    OperationId: EventControllerCreate

    Parameters

    • OptionaleventCreateDTO: EventCreateDTO

      EventCreateDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<EventOutputDTO>

    Throws

• eventControllerExport: function

  • eventControllerExport(
        eventSearchInputDTO?: EventSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Export events matching the search criteria to CSV format. Accepts the same parameters as the search endpoint. Maximum time range is 90 days. Required permissions: READ_EVENTS
    OperationId: EventControllerExport

    Parameters

    • OptionaleventSearchInputDTO: EventSearchInputDTO

      EventSearchInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• eventControllerGetFailedFunctions: function

  • eventControllerGetFailedFunctions(
        eventSearchInputDTO?: EventSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<EventOutputArrayDTOAPI>

    Fetches events where cronjob, hook and command failed. Supports all the common query parameters Required permissions: READ_MODULES, READ_EVENTS
    OperationId: EventControllerGetFailedFunctions

    Parameters

    • OptionaleventSearchInputDTO: EventSearchInputDTO

      EventSearchInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<EventOutputArrayDTOAPI>

    Throws

• eventControllerGetOne: function

  • eventControllerGetOne(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<EventOutputDTO>

    Required permissions: READ_EVENTS
    OperationId: EventControllerGetOne

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<EventOutputDTO>

    Throws

• eventControllerSearch: function

  • eventControllerSearch(
        eventSearchInputDTO?: EventSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<EventOutputArrayDTOAPI>

    Search events Required permissions: READ_EVENTS
    OperationId: EventControllerSearch

    Parameters

    • OptionaleventSearchInputDTO: EventSearchInputDTO

      EventSearchInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<EventOutputArrayDTOAPI>

    Throws