UpdateCertificationRuleRequest
A request or response body; the type column links to the schemas it refers to.
UpdateCertificationRuleRequest
| Field | Type | Required | Description |
|---|---|---|---|
| label | string | null | no | Send null to clear the label. 1–200 characters |
| threshold_hours | number | no | Hours required, for subject_hours rules. Counted from quantity evidence in hours or minutes, plus the elapsed time of date_range evidence. |
| threshold_count | integer | no | Completed records required, for subject_record_count rules. |
| evidence_type | string | no | Evidence type that must be present, for evidence_document rules. A pass_fail rule is met only by a row recording a pass. one of "score" | "date_range" | "quantity" | "url" | "file" | "pass_fail" | "note" |
| quiz_id | string (uuid) | no | Quiz that must be passed, for quiz_pass rules. A quiz of the type's own organization. |
| external_course_id | string (uuid) | no | Catalogue id of the external LMS course that must be passed, for external_course_pass rules. A course of the type's own organization. Passing is decided by the course: its passing_score when set, the imported passed flag otherwise. |
| scorm_course_id | string (uuid) | no | Hosted SCORM course that must be completed, for scorm_course_complete rules. A course of the type's own organization. Completion is what the course's completion records count: an attempt the module reported complete without an explicit failed verdict. |
| job_aid_id | string (uuid) | no | Job aid that must be viewed, for job_aid_viewed rules. An aid of the type's own organization. Viewing is an open of the aid's page (POST /job-aids/{job_aid_id}/views, which the page does on every load), inside the current recertification window; opens of its individual files do not count. |
| subject_matter_id | string (uuid) | null | no | Narrows a threshold rule to one of the type's subject tags; send null to count every tag again. |
{
"label": "string",
"threshold_hours": 20,
"threshold_count": 3,
"evidence_type": "score",
"quiz_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"external_course_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"scorm_course_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"job_aid_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"subject_matter_id": "1b671a64-40d5-491e-99b0-da01ff1f3341"
}