JobAidRef
A request or response body; the type column links to the schemas it refers to.
JobAidRef
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | yes | — |
| title | string | yes | — |
| description | string | null | yes | — |
| audience | string | yes | Whom the job aid is for. trainees: everyone its ownership admits — every member for an organization-owned aid, the owning department's role holders for a department-owned one — trainers included. trainers: only holders of job-aids:read over the aid's owner, for facilitator guides and the like; the aid is absent from everyone else's list. one of "trainees" | "trainers" |
| archived | boolean | yes | Whether the aid is archived — hidden from its audience. |
jsonExample
{
"id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"title": "string",
"description": "string",
"audience": "trainees",
"archived": true
}