Retrieve all Tasks for a Tray

List Tasks targeting the specified Tray.

Tasks are site-scoped; siteId must be the Site that owns the Tray. Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

Filters compose with AND: setting activeOnly=true restricts the result to tasks that are still in a non-terminal state (Pending, Running, Waiting). Results are paginated; the X-Pagination response header reports the total count over the post-filter set.

By default the report field is omitted from each task in the response. Set includeReport=true to include it; this is opt-in because report bodies can be several KB and pulling them across the list path persists the full payload in each caller-side workflow record. Single-task GET /rack/task/{id} and POST /rack/task/{id}/cancel always include the report.

siteIdstring uuid required

ID of the Site that owns the Tray.

activeOnlyboolean

Restrict results to non-terminal Tasks.

includeReportboolean

Include the per-task execution report on each returned task.

pageNumberinteger

Example:1

Page number for pagination query

pageSizeinteger

Example:20

Page size for pagination query

Response

OK

idstring uuid

Unique identifier of the task.

Current state of the task.

descriptionstring

Human-readable description provided when the task was created.

messagestring

Optional status or error message describing the current state or result.

ruleIdstring uuid nullable

Operation Rule that Flow resolved for this task — either because the caller pinned one via ruleId on the originating request or because Flow's default rule resolution picked it. Null if Flow has not yet recorded a resolution.

startedstring date-time

Timestamp when the task started execution.

finishedstring date-time

Timestamp when the task finished (succeeded, failed or terminated).

createdstring date-time

Timestamp when the task was created.

updatedstring date-time

Timestamp when the task was last updated.

Example response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "Running",
    "description": "Power on rack components",
    "message": "Processing 3 of 5 components",
    "ruleId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "report": {
      "version": 1,
      "stages": [
        {
          "number": 1,
          "status": "completed",
          "startedAt": "2026-06-08T18:00:00Z",
          "finishedAt": "2026-06-08T18:00:42Z",
          "steps": [
            {
              "componentType": "Compute",
              "status": "completed",
              "totalComponents": 4,
              "startedAt": "2026-06-08T18:00:00Z",
              "finishedAt": "2026-06-08T18:00:42Z"
            }
          ]
        },
        {
          "number": 2,
          "status": "running",
          "startedAt": "2026-06-08T18:00:42Z",
          "steps": [
            {
              "componentType": "NVLSwitch",
              "status": "running",
              "totalComponents": 2,
              "startedAt": "2026-06-08T18:00:42Z"
            },
            {
              "componentType": "PowerShelf",
              "status": "skipped",
              "totalComponents": 0
            }
          ]
        }
      ]
    }
  }
]

v57

Retrieve all Tasks for a Tray

Query parameters

Response

Example response