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, options?): AxiosPromise<TaskInfo>

  • Parameters

    • requestParameters: ScheduledTasksApiGetTaskRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<TaskInfo>

    Summary

    Get task by id.

    Throws

• getTasks:function

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

  • Parameters

    • requestParameters: ScheduledTasksApiGetTasksRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<TaskInfo[]>

    Summary

    Get tasks.

    Throws

• startTask:function

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

  • Parameters

    • requestParameters: ScheduledTasksApiStartTaskRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Start specified task.

    Throws

• stopTask:function

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

  • Parameters

    • requestParameters: ScheduledTasksApiStopTaskRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Stop specified task.

    Throws

• updateTask:function

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

  • Parameters

    • requestParameters: ScheduledTasksApiUpdateTaskRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Update specified task triggers.

    Throws