Function BackgroundTasksApiFactory

Returns {
    getTask(
        requestParameters: BackgroundTasksApiGetTaskRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TrackableTaskSchema>;
    getTasks(
        requestParameters?: BackgroundTasksApiGetTasksRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PageTrackableTaskSchema>;
}

• getTask: function

  • getTask(
        requestParameters: BackgroundTasksApiGetTaskRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TrackableTaskSchema>

    Return a specific background task

    Parameters

    • requestParameters: BackgroundTasksApiGetTaskRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<TrackableTaskSchema>

    Throws

• getTasks: function

  • getTasks(
        requestParameters?: BackgroundTasksApiGetTasksRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PageTrackableTaskSchema>

    Return a list of all non-expired background tasks

    Parameters

    • requestParameters: BackgroundTasksApiGetTasksRequest = {}

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PageTrackableTaskSchema>

    Throws