Publish an SOP
Módulo Knowledge
POST/sops/{id}/publishsops.publish
Publishes the SOP: the database stamps `published_at` and raises `version` when it was published before, so everyone is asked to acknowledge the new version. Needs knowledge.sop.publish. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requiere la capacidad knowledge.sop.publish.
- Alcances de OAuth: knowledge.
- Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
- Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the sop. |
Respuesta 200: Sop
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the sop. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| title | string | Sí | SOP title.Restricciones: length 1 to 300 |
| body | string | Sí | Procedure text.Restricciones: length 1 to 20000 |
| code | string | Sí | SOP code, SOP- and three to five digits.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| version | integer | Sí | Version number, raised on each publish.Restricciones: range 1 to any |
| published_at | string (date-time) | null | Sí | When the current version was published; null while draft. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"title": "Working at Height",
"body": "Confirm the dock slot, then stage by department.",
"code": "SOP-001",
"version": 1,
"published_at": "2026-10-08T14:30:00Z"
}Ejemplos de código
curl -X POST "$XOS_BASE_URL/sops/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/publish" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.sops.publish("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.sops.publish("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos sops publish 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f