Type Alias TasksAPI

type TasksAPI = {
    clearCache: typeof clearCache;
    createTask: typeof createTask;
    deleteTask: typeof deleteTask;
    getLastTaskRun: typeof getLastTaskRun;
    getTask: typeof getTask;
    getTaskRunLog: typeof getTaskRunLog;
    getTaskRuns: typeof getTaskRuns;
    getTasks: typeof getTasks;
    getTasksResourceRuns: typeof getTasksResourceRuns;
    startTask: typeof startTask;
    updateTask: typeof updateTask;
}
Index

Properties

clearCache createTask deleteTask getLastTaskRun getTask getTaskRunLog getTaskRuns getTasks getTasksResourceRuns startTask updateTask

Properties

clearCache: typeof clearCache

Clears the cache for tasks api requests.

createTask: typeof createTask

Creates a new task.

an object with query parameters

Param: body

an object with the body content

CreateTaskHttpError

deleteTask: typeof deleteTask

Deletes a specific task.

The task's unique identifier.

DeleteTaskHttpError

getLastTaskRun: typeof getLastTaskRun

Returns the last run of a specific task.

The task's unique identifier.

GetLastTaskRunHttpError

getTask: typeof getTask

Retrieves details for a specific task.

The task's unique identifier.

GetTaskHttpError

getTaskRunLog: typeof getTaskRunLog

Get specific run log of a task.

The task's unique identifier.

The run's unique identifier.

GetTaskRunLogHttpError

getTaskRuns: typeof getTaskRuns

Returns runs for the specified task.

The task's unique identifier.

an object with query parameters

GetTaskRunsHttpError

getTasks: typeof getTasks

Retrieves a list of the tasks that the requesting user has access to.

an object with query parameters

GetTasksHttpError

getTasksResourceRuns: typeof getTasksResourceRuns

Returns a list of task runs for a specified resourceId.

Filter tasks by its target resource ID

an object with query parameters

GetTasksResourceRunsHttpError

startTask: typeof startTask

Starts the specified task.

The task's unique identifier.

an object with query parameters

StartTaskHttpError

updateTask: typeof updateTask

Updates a specific task. If the task is owned by another user, ownership will be transferred to the requesting user.

The task's unique identifier.

Param: body

an object with the body content

UpdateTaskHttpError

Settings

Member Visibility

On This Page

Properties