Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

PlanRun

Retrieve a plan run

Used to retrieve an existing plan run

get/planRuns/{id}

Path parameters

idstring required

The ID of the plan run to retrieve

Response

The plan run that was retrieved

idstring

Object id. Set by system.

cloud_safe_idstring

Cloud safe ID representation (e.g. GCP/email/Kubernetes safe)

run_policy_idstring

Object id. Set by system.

organization_idstring

The organization that this run belongs to

application_idstring

DEPRECATED - The application that this run is for

environment_idstring

DEPRECATED - The environment that this run is against

deployment_idstring

DEPRECATED - The deployment that this run is for

deployment_idsstring[]

The deployment IDs associated with this run

debugboolean

If true will capture additional debugging information during execution

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

Current status of the job

status_causestring

Cause for setting given status, such as failure cause. Updated in pairs with Status.

target_runtime_versionstring

Target execution test runner image tag to execute

target_orchestration_versionstring

Optional orchestration runtime version to use, if applicable. Otherwise use default orchestration version.

runtime_api_imagestring

Preview API image to use

test_recovery_agent_mode_override'off' | 'fail_at_end' | 'pass' | 'inherit'

Test Recovery Agent mode. Use inherit (plan-level only) to defer to the workspace-level default.

trace_fidelity_override'full' | 'metrics' | 'inherit'

How much Chrome trace data to capture. full records the complete category set, and is what the "Download step trace" artifact contains. metrics records only the categories the published performance measures are computed from, so a trace downloaded from a metrics run carries the film strip and timeline but not the full set of Chrome records. inherit defers to the next level down.

execution_source'mabl_cloud' | 'external' | 'mabl_local' | 'mabl_agent'

Where the test lives

ref_idstring

Reference id to this plan in another system

plan_ref_idstring

Reference id to this plan in another system

execution_runner_type'cloud_java_v1' | 'cloud_nodejs_v2'

[Deprecated] Test execution runner to use, optional

terminated_by_idstring

The ID of the user who terminated this plan run

scheduler_idstring

the id of process that scheduled this plan run

trigger_type'manual' | 'retry' | 'schedule' | 'customer_event' | 'insight' | 'external'

the type of trigger scheduling this plan run

triggering_resource_idstring

the id of the entity that triggered the plan run

triggering_resource_typestring

the type of the entity that triggered the plan run

triggering_resource_is_supportboolean

this plan run was triggered by a mabl support team member

source_control_tag_overridestring

The source control tag override that was used for this plan run, if any

created_timeinteger

time the plan run was created

created_by_idstring

The ID of the user who created this plan run

schedule_timeinteger

time the plan run was scheduled

completed_timeinteger

time the plan run completed

last_updated_timeinteger

time the plan run object was last updated

last_updated_by_idstring

The ID of the user who last updated this plan run

execution_graphstring

DEPRECATED - Graph describing how the journey runs in this plan run will execute

retry_countinteger

Indicates the retry count for this plan run (0 = initial run, 1 = first retry, etc.)

retry_of_idstring

The ID of the plan run that triggered this retry

retry_type'all' | 'failed' | 'failed_and_skipped'

If this is a retry, whether to retry all tests, failed tests only, or failed and skipped tests

will_retryboolean

Whether or not the plan will retry