Sign in
Practice reviews

Invalidate an observation that was wrong when recorded, or restore it

Changed on

Invalidating stops feedback citing the observation that has not reached anyone yet. Feedback already delivered keeps its record, and a comment already posted on the provider stays there. Restoring does not re-send anything.

patch/workspaces/{workspaceSlug}/practices/reviews/observations/{observationId}/validity

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/practices/reviews/observations/{observationId}/validity
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

observationIdstring uuid required

Request body

reasonstring required

Why, kept with the correction; an invalidation reason is shown to the developer

validboolean required

false invalidates the observation; true restores it

Response

Observation detail after the change

agentJobIdstring uuid required
claimCurrentness'CURRENT' | 'STALE' | 'UNVERIFIABLE' required

Whether an observation's claim still stands: its practice's review rules are unchanged and it was not superseded, which an issue's observations are when a change to its reviewable content is recorded. It says neither whether a later review ran nor whether the work changed since it was reviewed. Earlier observation standards and missing fingerprints are unverifiable under the current whole-practice standard

evidenceRationalestring
idstring uuid required
observedAtstring date-time required
origin'LIVE' | 'MANUAL' | 'BACKFILL' required

How the review that recorded it came about: LIVE from the work itself, MANUAL requested by a person, BACKFILL over work that predates the connection. A recurring sweep records LIVE.

outcome'MET' | 'NOT_MET' | 'NOT_APPLICABLE' | 'UNDETERMINED' required

Result of the practice review

practiceNamestring required
practiceRevisionIdinteger

Criteria revision selected as of job start, when available

practiceSlugstring required
recurrenceKeystring

Cross-run locus key; null when continuity is unavailable

severity'CRITICAL' | 'MAJOR' | 'MINOR' | 'INFO'

Severity band (null unless outcome is NOT_MET)

summarystring required
supersededAtstring date-time

When a later review of the same work superseded this observation; null while current

Changes

  • 9662502b2cc4Revision changes
    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$

  • fc28962fd0a6Revision changes
    • warning

      added the new PUBLIC_SUBJECT_INELIGIBLE enum value to the // response property for the response status