Saltar al contenido

Create a training lesson

Módulo Workforce

POST/training-lessonstrainingLessons.create

A lesson of a training course: a reading, a video or a quiz. Changes only while the course is a draft. Creates a training lesson. 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.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, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: TrainingLessonCreate

trainingLessons.create: TrainingLessonCreate
CampoTipoObligatorioDescripción
training_course_idstring (uuid)SíIdentifier of the course.
positionintegerSíOrder, from 1.Restricciones: range 1 to any
titlestringSíLesson title.Restricciones: length 1 to 200
lesson_kind"Reading" | "Video" | "Quiz"SíLesson kind.
bodystring | nullNoReading text or notes.Restricciones: length 1 to 20000
video_urlstring (uri) | nullNoHTTPS address of the lesson video.
{
  "training_course_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "position": 1,
  "title": "Slings",
  "lesson_kind": "Reading",
  "body": "Inspect every sling before use.",
  "video_url": "https://northwindlive.example/files/site-plan.pdf"
}

Respuesta 201: TrainingLesson

trainingLessons.create: TrainingLesson
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the training lesson.
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íPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíPerson who last updated the row; null for seed, platform or system writes.
training_course_idstring (uuid)SíIdentifier of the course.
positionintegerSíOrder, from 1.Restricciones: range 1 to any
titlestringSíLesson title.Restricciones: length 1 to 200
lesson_kind"Reading" | "Video" | "Quiz"SíLesson kind.
bodystring | nullSíReading text or notes.Restricciones: length 1 to 20000
video_urlstring (uri) | nullSíHTTPS address of the lesson video.
{
  "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",
  "training_course_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "position": 1,
  "title": "Slings",
  "lesson_kind": "Reading",
  "body": "Inspect every sling before use.",
  "video_url": "https://northwindlive.example/files/site-plan.pdf"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/training-lessons" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"training_course_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","position":1,"title":"Slings","lesson_kind":"Reading","body":"Inspect every sling before use.","video_url":"https://northwindlive.example/files/site-plan.pdf"}'
const { data } = await xos.trainingLessons.create({
    "training_course_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "position": 1,
    "title": "Slings",
    "lesson_kind": "Reading",
    "body": "Inspect every sling before use.",
    "video_url": "https://northwindlive.example/files/site-plan.pdf"
  });
response = xos.training_lessons.create({"training_course_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "position": 1, "title": "Slings", "lesson_kind": "Reading", "body": "Inspect every sling before use.", "video_url": "https://northwindlive.example/files/site-plan.pdf"})
xos training-lessons create --data '{"training_course_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","position":1,"title":"Slings","lesson_kind":"Reading","body":"Inspect every sling before use.","video_url":"https://northwindlive.example/files/site-plan.pdf"}'