latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

PlanRun

Queries plan runs

Used to query plan runs

get/planRuns/workspace/{workspace_id}

Path parameters

workspace_idstring required

The workspace associated with the plan

Query parameters

environment_idstring

The environment associated with the plan

status'cancelled' | 'completed' | 'failed' | 'post_execution' | 'pre_execution' | 'queued' | 'scheduled' | 'scheduling' | 'succeeded' | 'terminated'

The plan run status

plan_idstring

The ID of the plan to query by

limitinteger

The limit to use for pagination

cursorstring

The cursor to use for pagination

populate_test_script_executionsboolean

If we should populate the test script executions or not

min_created_timeinteger

The min_created_time to use for querying any plan run after given created time in milliseconds

include_ad_hoc_runsboolean

Whether to include ad-hoc runs in the results. Defaults to true if not specified.

include_latest_xray_syncboolean

Whether to include each plan run's latest Xray sync status and error message in the results; requires a limit of at most 50. Defaults to false if not specified.

Response

Array of plan runs matching the query

cursorstring

Cursor used for pagination