AUautify
Triggers – Plans

Get plan run status

Returns the overall status and per-case breakdown of a plan run.

get/api/triggers/plans/{planId}/runs/{planRunId}

Request

Path parameters

planIdstring uuid required

UUID of the test plan.

planRunIdstring uuid required

UUID of the plan run returned by the trigger endpoint.

Response

Plan run details.

idstring uuid required
status'created' | 'running' | 'completed' | 'failed' | 'cancelled' required
triggerSource'manual' | 'scheduled' | 'api' required
executionMode'parallel' | 'sequential' required

The effective mode this run executed with.

deviceMode'pool' | 'matrix' required

How this run used the plan's devices.

totalCasesinteger required
completedCasesinteger required
passedCasesinteger required
failedCasesinteger required
startedAtstring date-time nullable
completedAtstring date-time nullable
createdAtstring date-time required
tagsstring[] required

Caller-supplied labels, for example the commit and pull request a run was testing. At most 10, each 1-64 characters after trimming; duplicates are collapsed. A request exceeding a bound is refused with 400, never truncated. Tags are returned exactly as stored and are visible to everyone in your organization, so never put secrets in them.

archivedAtstring date-time nullable

Set when the run was archived (soft-deleted). Archived runs are excluded from the runs list but stay readable by id.

resumedFromRunIdstring uuid nullable

The run this one was started to finish, if any.

resumedByRunIdstring uuid nullable

The run started to finish this one, if any. A run can only be resumed once.

remainingCasesinteger

How many cases this run left unexecuted and the plan still contains. Counts cases that were pending, running, cancelled or skipped when the run stopped. Always 0 while the run is still going.

canResumeboolean

Whether POST /api/triggers/plans/{planId}/runs/{planRunId}/resume would be accepted. False while the run is still going, once it has already been resumed, when nothing is left to execute, and for runs started before resuming was supported.

Example response

{
  "tags": [
    "git:sha:3f2c1e9a7b6d5c4e3f2a1b0c9d8e7f6a5b4c3d2e",
    "genesis:pr:1234"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.