Saltar al contenido

Create a SOP

Módulo Knowledge

POST/sopssops.create

A standard operating procedure that members acknowledge. Creates a SOP. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad knowledge.sop.write.
  • 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, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: SopCreate

sops.create: SopCreate
CampoTipoObligatorioDescripción
titlestringSíSOP title.Restricciones: length 1 to 300
bodystringSíProcedure text.Restricciones: length 1 to 20000
codestringSíSOP code, SOP- and three to five digits.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "title": "Working at Height",
  "body": "Confirm the dock slot, then stage by department.",
  "code": "SOP-001"
}

Respuesta 201: Sop

sops.create: Sop
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the sop.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
titlestringSíSOP title.Restricciones: length 1 to 300
bodystringSíProcedure text.Restricciones: length 1 to 20000
codestringSíSOP code, SOP- and three to five digits.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
versionintegerSíVersion number, raised on each publish.Restricciones: range 1 to any
published_atstring (date-time) | nullSí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" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"title":"Working at Height","body":"Confirm the dock slot, then stage by department.","code":"SOP-001"}'
const { data } = await xos.sops.create({
    "title": "Working at Height",
    "body": "Confirm the dock slot, then stage by department.",
    "code": "SOP-001"
  });
response = xos.sops.create({"title": "Working at Height", "body": "Confirm the dock slot, then stage by department.", "code": "SOP-001"})
xos sops create --data '{"title":"Working at Height","body":"Confirm the dock slot, then stage by department.","code":"SOP-001"}'