Function ScheduledTasksApiFactory

Returns {
    getTask(
        requestParameters: ScheduledTasksApiGetTaskRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TaskInfo>;
    getTasks(
        requestParameters?: ScheduledTasksApiGetTasksRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TaskInfo[]>;
    startTask(
        requestParameters: ScheduledTasksApiStartTaskRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    stopTask(
        requestParameters: ScheduledTasksApiStopTaskRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    updateTask(
        requestParameters: ScheduledTasksApiUpdateTaskRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
}

• getTask: function

  • getTask(
        requestParameters: ScheduledTasksApiGetTaskRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TaskInfo>

    Parameters

    • requestParameters: ScheduledTasksApiGetTaskRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<TaskInfo>

    Throws

• getTasks: function

  • getTasks(
        requestParameters?: ScheduledTasksApiGetTasksRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TaskInfo[]>

    Parameters

    • requestParameters: ScheduledTasksApiGetTasksRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<TaskInfo[]>

    Throws

• startTask: function

  • startTask(
        requestParameters: ScheduledTasksApiStartTaskRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: ScheduledTasksApiStartTaskRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• stopTask: function

  • stopTask(
        requestParameters: ScheduledTasksApiStopTaskRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: ScheduledTasksApiStopTaskRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• updateTask: function

  • updateTask(
        requestParameters: ScheduledTasksApiUpdateTaskRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: ScheduledTasksApiUpdateTaskRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws