Circle V2 API Docs
    Preparing search index...

    Function isTerminalFormRunStatus

    • Whether a form_runs status is terminal (the run will not progress further).

      form_runs statuses only; other run-status domains (job_executions, rpa_runs, audit_status) have different terminal sets — do not reuse this for them.

      Accepts raw strings so it can classify legacy v1 statuses too: v1 terminal statuses (completed, failed) coincide with v2's and are terminal; v1 in-flight statuses (in_progress, checking_namespaces, answering, chunking, chunking_skipped, searching, running) are non-terminal, as is any unknown status.

      Note: the legacy v2 UI (PatientGeneratedFormsList) currently uses status !== 'running' semantics; it will be aligned to this helper in PR12.

      Parameters

      • status: string

      Returns boolean