Sign in
Task Run

Retrieve all Task Runs

List Task Runs on a Site. Filters compose with AND; results are paginated and the X-Pagination response header reports the total count over the post-filter set.

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

get/v2/org/{org}/nico/task/run

Query parameters

siteIdstring uuid required

ID of the Site that owns the Task Runs (Task Runs are site-scoped).

status'Pending' | 'Running' | 'Paused' | 'Completed' | 'Cancelled' | 'Failed' | 'CompletedWithFailures'

Filter by Task Run status.

operationType'PowerControl' | 'FirmwareControl'

Filter by operation type.

pageNumberinteger

One-indexed page number.

Page number of results returned (1-indexed).

pageSizeinteger

Number of results per page.

Response

OK

idstring uuid required

Unique identifier of the Task Run.

namestring required

Human-readable name of the Task Run.

descriptionstring

Optional free-form description.

operationType'PowerControl' | 'FirmwareControl' required

Type of operation this Task Run executes. Currently always FirmwareControl.

operationCodestring

Operation code within the operation type (e.g. upgrade).

status'Unknown' | 'Pending' | 'Running' | 'Paused' | 'Completed' | 'Cancelled' | 'Failed' | 'CompletedWithFailures' required

Current lifecycle state of the Task Run.

statusReason'Unknown' | 'None' | 'OperatorPaused' | 'PhaseGate' | 'SafetyGate' | 'ConflictRetryTimeout' required

Why the Task Run is paused or terminal (e.g. PhaseGate, SafetyGate). None when there is no qualifying reason.

statusMessagestring

Optional human-readable detail for the current status.

totalPhasesinteger required

Total number of phases the selected targets were divided into.

createdstring date-time required

Timestamp when the Task Run was created.

updatedstring date-time required

Timestamp when the Task Run was last updated.

startedstring date-time nullable

Timestamp when the Task Run started execution. Null before it starts.

finishedstring date-time nullable

Timestamp when the Task Run reached a terminal state. Null while active.

Changes

Changed in 3 of the 90 revisions of this API.22

  • c459c6587dee2See the full diff
    • ●

      for the query request parameter pageNumber, the max was set to 21474836.00

      request-parameter-max-set

    • ●

      for the query request parameter pageSize, the max was set to 100.00

      request-parameter-max-set

  • 441cfc1afc1c1See the full diff
    • ○

      added the non-success response with the status 504

      response-non-success-status-added

  • ac0607a420811See the full diff
    • ○

      endpoint added

      endpoint-added