Test Plans

Get a test plan

Returns a plan's full detail: settings, plan variables (secret values are masked as *** and flagged with isSecret), and its cases in execution order.

get/api/plans/{planId}

Request

Path parameters

planIdstring uuid required

Response

Plan detail.

idstring uuid required
projectIdstring uuid required
titlestring required
descriptionstring nullable
apiEnabledboolean required

Whether the plan can be triggered through the API.

executionMode'parallel' | 'sequential' required
stopOnFailureboolean required
deviceMode'pool' | 'matrix' required

pool: each case runs once on whichever configured device is free. matrix: each case runs on every configured device.

caseCountinteger required
archivedAtstring date-time nullable

Set when the plan was archived (soft-deleted). Archived plans are excluded from lists but stay readable by id.

createdAtstring date-time required
updatedAtstring date-time required

Changes

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