handbookArticles
Workforce module · 7 operations
List handbook article rows
GET/handbook-articles
A handbook or SOP article: versioned on publish, optionally a mandatory read acknowledged per version. Returns a cursor page of handbook article rows the caller may see. The default order is `title` ascending. Supports sparse fieldsets and the filter grammar.
Create a handbook article
POST/handbook-articles
A handbook or SOP article: versioned on publish, optionally a mandatory read acknowledged per version. Creates a handbook article. 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 handbook article
GET/handbook-articles/{id}
A handbook or SOP article: versioned on publish, optionally a mandatory read acknowledged per version. Returns one handbook article with its `ETag`. A handbook article the caller may not see returns 404.
Update a handbook article
PATCH/handbook-articles/{id}
A handbook or SOP article: versioned on publish, optionally a mandatory read acknowledged per version. 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 an article
POST/handbook-articles/{id}/publish
Publishes the working text as the next version; a mandatory article then asks everyone to acknowledge it. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
Acknowledge an article
POST/handbook-articles/{id}/acknowledge
Records that the caller read the current version. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
Archive an article
POST/handbook-articles/{id}/archive
Withdraws a published article. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.