ForumResource
A request or response body; the type column links to the schemas it refers to.
ForumResource
| Field | Type | Required | Description |
|---|---|---|---|
| kind | string | yes | What the link points at: one of the organization's job aids, hosted SCORM courses, quizzes or training events. one of "job_aid" | "scorm_course" | "quiz" | "training_event" |
| id | string (uuid) | yes | — |
| label | string | yes | The resource's current title or name. |
| href | string | yes | The page of this deployment that opens the resource for the caller: the learner's own page for a job aid, course or assigned quiz, the administration page for a quiz reached through quizzes:read, the event's page for an event. |
jsonExample
{
"kind": "job_aid",
"id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"label": "Forklift pre-start checklist",
"href": "/my-job-aids/0b6f3c2e-6a51-4c55-9e8a-2f7d9b1c4a10"
}