trainingCourses
Workforce module · 8 operations
List training course rows
GET/training-courses
A short training course of lessons and quizzes with completion records and expiry, linked to a role, a certification and a gate criterion. Returns a cursor page of training course rows the caller may see. The default order is `title` ascending. Supports sparse fieldsets and the filter grammar.
Create a training course
POST/training-courses
A short training course of lessons and quizzes with completion records and expiry, linked to a role, a certification and a gate criterion. Creates a training course. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
Get a training course
GET/training-courses/{id}
A short training course of lessons and quizzes with completion records and expiry, linked to a role, a certification and a gate criterion. Returns one training course with its `ETag`. A training course the caller may not see returns 404.
Update a training course
PATCH/training-courses/{id}
A short training course of lessons and quizzes with completion records and expiry, linked to a role, a certification and a gate criterion. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
Publish a course
POST/training-courses/{id}/publish
Publishes a draft course with at least one lesson and every quiz keyed. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
Retire a course
POST/training-courses/{id}/retire
Retires a published course. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
Assign a course
POST/training-courses/{id}/assign
Assigns a published course to active members with an optional due date. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
Complete a course
POST/training-courses/{id}/complete
Grades the caller's quiz answers once every reading and video lesson is finished. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.