Type Alias TasksAPI

Index

Properties

clearCache: typeof tasks.clearCache

Clears the cache for tasks api requests.

createTask: typeof tasks.createTask

Creates a new task for the specified resource. The task is owned by the requesting user and is disabled by default until explicitly enabled. The resourceId is derived automatically from the task's state definitions and cannot be set directly in the request body.

an object with query parameters

an object with the body content

CreateTaskHttpError

deleteTask: typeof tasks.deleteTask

Deletes a specific task and cancels any scheduled or pending runs associated with it. This action cannot be undone. Tenant admins can delete tasks owned by other users.

The unique identifier of the task to delete.

DeleteTaskHttpError

getTask: typeof tasks.getTask

Retrieves the full definition and metadata for a specific task, including its trigger configuration, state definitions, owner, and last run status. Use this operation to inspect a task before updating or starting it.

The unique identifier of the task to retrieve.

GetTaskHttpError

getTaskGraphsAncestors_FIX_THIS_QUIRKY_NAME: typeof getTaskGraphsAncestors_FIX_THIS_QUIRKY_NAME

Retrieves the ancestor subgraph for a specific task, with the requested task as the root vertex. Traverses parent relationships breadth-first up to the depth specified by level. Use this to understand all upstream dependencies of a task.

The unique identifier of the task.

an object with query parameters

GetTaskGraphsAncestors_FIX_THIS_QUIRKY_NAMEHttpError

getTaskGraphsChildren_FIX_THIS_QUIRKY_NAME: typeof getTaskGraphsChildren_FIX_THIS_QUIRKY_NAME

Retrieves a paginated list of tasks that are direct children of the specified task in the dependency graph. A child task is one that is triggered when the parent task completes successfully.

The unique identifier of the parent task.

an object with query parameters

GetTaskGraphsChildren_FIX_THIS_QUIRKY_NAMEHttpError

getTaskGraphsDescendants_FIX_THIS_QUIRKY_NAME: typeof getTaskGraphsDescendants_FIX_THIS_QUIRKY_NAME

Retrieves the descendant subgraph for a specific task, with the requested task as the root vertex. Traverses child relationships breadth-first down to the depth specified by level. Use this to identify all downstream tasks that will be triggered when this task completes.

The unique identifier of the task.

an object with query parameters

GetTaskGraphsDescendants_FIX_THIS_QUIRKY_NAMEHttpError

getTaskGraphsParents_FIX_THIS_QUIRKY_NAME: typeof getTaskGraphsParents_FIX_THIS_QUIRKY_NAME

Retrieves a paginated list of tasks that are direct parents of the specified task in the dependency graph. A parent task is one whose completion triggers the current task.

The unique identifier of the child task.

an object with query parameters

GetTaskGraphsParents_FIX_THIS_QUIRKY_NAMEHttpError

getTaskGraphsSubgraph_FIX_THIS_QUIRKY_NAME: typeof getTaskGraphsSubgraph_FIX_THIS_QUIRKY_NAME

Retrieves the combined ancestor-and-descendant subgraph for a specific task, with the requested task as the root vertex. Traverses both parent and child relationships breadth-first up to the depth specified by level. Use this to see the full dependency context for a task in one request.

The unique identifier of the task.

an object with query parameters

GetTaskGraphsSubgraph_FIX_THIS_QUIRKY_NAMEHttpError

getTaskRunLog: typeof tasks.getTaskRunLog

Retrieves the execution log for a specific task run. Set the Accept header to text/plain to receive the raw log as a downloadable file, or application/json (default) to receive it wrapped in a JSON object with a logContent field.

The unique identifier of the task.

The unique identifier of the task run.

GetTaskRunLogHttpError

getTaskRuns: typeof tasks.getTaskRuns

Retrieves a paginated list of execution runs for the specified task, ordered by most recent run by default. Each run record includes the start and end time, status, and the identity that triggered it.

The unique identifier of the task.

an object with query parameters

GetTaskRunsHttpError

getTaskRunsLast_FIX_THIS_QUIRKY_NAME: typeof getTaskRunsLast_FIX_THIS_QUIRKY_NAME

Retrieves the most recent execution run for the specified task. Returns a 404 response if the task has never been run. Use this operation to quickly check whether the last run succeeded or failed without paginating through the full run history.

The unique identifier of the task.

GetTaskRunsLast_FIX_THIS_QUIRKY_NAMEHttpError

getTasks: typeof tasks.getTasks

Retrieves a paginated list of tasks the requesting user has access to. Results include task metadata such as owner, resource, space, and last run status. Use the filter parameter to narrow results by field values, or sort to control the ordering.

an object with query parameters

GetTasksHttpError

getTasksResourceRuns_FIX_THIS_QUIRKY_NAME: typeof getTasksResourceRuns_FIX_THIS_QUIRKY_NAME

Retrieves a paginated list of task runs for a given resource, identified by id. Returns run history across all tasks associated with that resource, ordered by the most recent run by default.

The unique identifier of the resource to retrieve task runs for.

an object with query parameters

GetTasksResourceRuns_FIX_THIS_QUIRKY_NAMEHttpError

patchTask: typeof patchTask

Partially updates a specific task using a JSON Patch document (RFC 6902). Only the fields included in the patch operations are modified. All other fields remain unchanged. If the task is owned by another user, ownership is transferred to the requesting user.

The unique identifier of the task to update.

an object with the body content

PatchTaskHttpError

startTask: typeof tasks.startTask

Triggers an immediate run of the specified task outside its normal schedule. The optional source parameter identifies what initiated the run, which is recorded in the run history for auditing purposes.

The unique identifier of the task to start.

an object with query parameters

StartTaskHttpError

updateTask: typeof tasks.updateTask

Replaces the full definition of a specific task with the supplied payload. All fields not included in the request body are reset to their defaults. If the task is owned by another user, ownership is transferred to the requesting user. Use PATCH instead to apply a partial update.

The unique identifier of the task to replace.

an object with the body content

UpdateTaskHttpError