Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

PlanRun

Categorize all failed journey runs within a plan run.

put/planRun/{plan_run_id}/failureCategorization

Path parameters

plan_run_idstring required

The ID of the plan run to update

Query parameters

override_existing_failure_categorizationsboolean

If true, overrides any existing failure reasons on a journey run.

Request body

failure_category_idstring

A failure category id

failure_synopsisstring

DEPRECATED -- Now persisted as FailureAnalysis -- A synopsis of the failure summary

failure_summary_textstring

A summary describing the test run failure and potential root cause

is_failure_category_generatedboolean

Indicates if the failure category was generated by AI

is_failure_summary_generatedboolean

Indicates if the failure summary was generated by AI

suggested_failure_category_idstring

Failure category ID suggested by automated analysis

last_updated_by_idstring

The ID of the user who updated the categorization of this failure

last_updated_timeinteger

time the failure categorization was last updated

failure_reason_assignment_source'manual' | 'auto'

How the failure reason was assigned to this test run. Server-managed; client-supplied values are ignored on write.

failure_reason_assigned_by_idstring

The ID of the user or system that assigned the failure reason. Server-managed; client-supplied values are ignored on write.

failure_reason_assigned_timeinteger

Timestamp in epoch milliseconds when the failure reason was assigned. Server-managed; client-supplied values are ignored on write.

Response

The journey runs in the plan run were updated