Takaro - v0.4.9
    Preparing search index...

    Function EventApiAxiosParamCreator

    • EventApi - axios parameter creator

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          eventControllerCreate: (
              eventCreateDTO?: EventCreateDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          eventControllerExport: (
              eventSearchInputDTO?: EventSearchInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          eventControllerGetFailedFunctions: (
              eventSearchInputDTO?: EventSearchInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          eventControllerGetOne: (
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          eventControllerSearch: (
              eventSearchInputDTO?: EventSearchInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
      }

      • eventControllerCreate: (
            eventCreateDTO?: EventCreateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Required permissions: MANAGE_EVENTS
        OperationId: EventControllerCreate

      • eventControllerExport: (
            eventSearchInputDTO?: EventSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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

      • eventControllerGetFailedFunctions: (
            eventSearchInputDTO?: EventSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

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

      • eventControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Required permissions: READ_EVENTS
        OperationId: EventControllerGetOne

      • eventControllerSearch: (
            eventSearchInputDTO?: EventSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Search events Required permissions: READ_EVENTS
        OperationId: EventControllerSearch