CreateJobAidRequest
A request or response body; the type column links to the schemas it refers to.
CreateJobAidRequest
| Field | Type | Required | Description |
|---|---|---|---|
| org | string | yes | Organization UUID id or slug the job aid belongs to. at least 1 character |
| department | string | no | UUID id or slug of the owning department within the organization; omit for an aid owned by the organization directly. Ownership scopes administration and limits reading the aid to the department's role holders. at least 1 character |
| title | string | yes | 1–200 characters |
| description | string | no | Omit or send empty for no summary. at most 2000 characters |
| body_markdown | string | no | Omit or send empty for no body; files are attached afterwards. at most 200000 characters |
| audience | string | no | Defaults to trainees: open to everyone the aid's ownership admits. one of "trainees" | "trainers" |
| subject_matter_ids | array of string (uuid) | no | Subjects of the aid's organization to tag it with. Omit for an untagged aid. at most 50 items |
jsonExample
{
"org": "acme-corporation",
"department": "string",
"title": "Forklift pre-start checklist",
"description": "string",
"body_markdown": "string",
"audience": "trainees",
"subject_matter_ids": [
"1b671a64-40d5-491e-99b0-da01ff1f3341"
]
}