practice-review-output

Get a review result

Changed on
get/workspaces/{workspaceSlug}/practices/reviews/results/{resultId}

Request

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

Path parameters

workspaceSlugstring required

Workspace slug

resultIdstring uuid required

Response

OK

acceptedAtstring date-time nullable required
currentness'CURRENT' | 'STALE' | 'UNVERIFIABLE' required
endReason'REPLACED' | 'OUTRANKED' | 'WORK_CHANGED' | 'REPAIRED' | 'REMOVED' | 'null' nullable required
endedAtstring date-time nullable required
evidenceHiddenboolean required
evidenceVersioninteger required
explanationstring nullable required
idstring uuid required
itemVersionstring nullable required
markedIncorrectAtstring date-time nullable required
origin'EVENT' | 'REQUEST' | 'SCHEDULE' | 'BACKFILL' required
outcome'MET' | 'NOT_MET' | 'DOES_NOT_APPLY' | 'COULD_NOT_DETERMINE' required
practiceNamestring required
practiceSlugstring required
practiceVersionIdstring nullable required
practiceVersionNumberinteger nullable required
recordedAtstring date-time required
reviewIdstring uuid required
severity'CRITICAL' | 'MAJOR' | 'MINOR' | 'TRIVIAL' | 'null' nullable required
summarystring nullable required

Changes