Practice Observations

Get observation detail

Changed on
get/workspaces/{workspaceSlug}/practices/observations/{observationId}

Request

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

Path parameters

workspaceSlugstring required

Workspace slug

observationIdstring uuid required

Response

Observation detail returned

artifactIdinteger required

Artifact entity ID

artifactKindstring required

Artifact type (e.g. PULL_REQUEST)

artifactUrlstring

Link to the reviewed artifact on its platform (null when it cannot be resolved)

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

deliveredFeedbackstring

The summary body of the newest eligible feedback about this observation to this developer (null when no summary body was recorded, including delivery through inline notes only)

evidenceRationalestring

Evidence-based rationale for the observation

feedbackCommentUrlsstring[]

Links to the comments on the reviewed work that carry the feedback behind feedbackResponse, summary first (null when that feedback was not delivered on the work or the platform returned no link)

idstring uuid required

Observation ID

invalidatedAtstring date-time

When a workspace admin marked this observation as incorrect; null while it stands. An invalidated observation counts toward nothing current.

invalidationReasonstring

The admin's reason for the invalidation; null while the observation stands

nextStepstring

The next step the review wrote about this observation, whether or not the feedback carrying it was delivered (null when it wrote none)

observedAtstring date-time required

When the observation was made

origin'LIVE' | 'MANUAL' | 'BACKFILL' required

What occasioned the measurement; never mix origins in one trend line

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

Result of the practice review

practiceNamestring required

Practice name

practiceSlugstring required

Practice slug

recurrenceKeystring

Cross-run locus key; null when continuity is unavailable

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

Severity level (null unless outcome is NOT_MET)

summarystring required

Observation summary

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]$

    • info

      added the optional property to the response with the status