Skip to main content

Listing and Managing Tasks

The tasks page at /repositories/:repositoryId/tasks shows the executions related to a repository. Use it to create tasks, track current work, retry interrupted runs, download completed results, or remove task records.

When to use​

  • Use the page to review all tasks for a repository.
  • Use it to track statuses and open execution details.
  • Use it to download results from completed tasks.
  • Use it to stop, restart, or delete a task when the action is available.

Before you start​

  • Confirm the active organization.
  • Open a repository that has completed pre-analysis.
  • Check that no conflicting task is already pending or running.

Accessing tasks​

You can open the task list from:

  • The repository workspace tabs.
  • The recommended action on the repositories page.
  • The command palette when a repository is active.

If you enter from a global route, select a repository first. The repository must be ready for task execution. If no repository is available, the page guides you back to the repository list.

Understand the list​

The list shows the executions for the selected repository. You can:

  • Search by task name, description, type, language, or status.
  • Filter by status.
  • Create a new task.
  • Open task details.
  • Download the result of a completed task.
  • Restart a failed, cancelled, or revoked task.
  • Stop a running or pending task.
  • Delete a task.

Task statuses​

Tasks can have the following statuses:

  • PENDING: the task was created and is waiting to run.
  • RUNNING, STARTED, RECEIVED, RETRY: the task is in progress.
  • SUCCESS: the task completed and results are available.
  • FAILURE: the task failed.
  • REVOKED: the task was revoked.
  • CANCELLED: the task was cancelled.
  • STOPPING: the app is stopping a running task.

When pending or in-progress tasks exist, the list refreshes automatically at intervals. Success messages appear temporarily and can be dismissed. Error messages remain visible until the user closes them, so the reason can be read before retrying.

Task actions​

Available actions depend on the task status:

  • View: opens the task detail and progress screen.
  • Download: downloads the result package for a successful task.
  • Stop: asks for confirmation before stopping a running or pending task.
  • Restart: starts a new attempt for a failed, cancelled, or revoked task.
  • Delete: removes the task after confirmation.

If the API blocks a new task because another task is pending or running, wait for the active task to finish or stop it before creating another one.

Task status sequence​

Tasks usually move from PENDING to worker states such as RECEIVED, STARTED, and RUNNING. They can then finish with SUCCESS, fail with FAILURE, retry with RETRY, or move to STOPPING and CANCELLED when the user requests a stop.

Revoked, failed, or cancelled tasks can be restarted when the action is available. Before restarting, review the visible error message and logs in the task detail screen.

Knowledge base behavior​

Task execution contributes to the repository knowledge base. Later documentation can benefit from information collected by earlier runs, and downloaded results can include cumulative content depending on the selected task options.

Expected result​

The list should show the current state of executions and offer only actions compatible with each status.

See also​