API ReferenceRack

Retrieve all Tasks for a Rack

View as Markdown
List Tasks targeting the specified Rack. Tasks are site-scoped; `siteId` must be the Site that owns the Rack. 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.

Authentication

AuthorizationBearer
``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired
Name of the Org
idstringRequiredformat: "uuid"
UUID of the Rack

Query parameters

siteIdstringRequiredformat: "uuid"
ID of the Site that owns the Rack.
activeOnlybooleanOptionalDefaults to false

Restrict results to non-terminal Tasks.

includeReportbooleanOptionalDefaults to false

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

pageNumberintegerOptional>=1Defaults to 1
Page number for pagination query
pageSizeintegerOptional1-100
Page size for pagination query

Response headers

X-Paginationstring
Pagination result in JSON format

Response

OK
idstringformat: "uuid"
Unique identifier of the task.
statusenum
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 or nullformat: "uuid"

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.

starteddatetime
Timestamp when the task started execution.
finisheddatetime

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

createddatetime
Timestamp when the task was created.
updateddatetime
Timestamp when the task was last updated.
reportobject

Structured v1 execution report for the task. Populated on single-task GET and cancel responses, and on list responses only when includeReport=true is set. Omitted when the task has not yet produced a report (e.g. still queued) or when the caller did not opt in on list endpoints.

A future schema revision will be exposed as a new TaskReportV2 schema referenced from a parallel response field; v1 consumers are not disturbed by that bump.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error