Saltar al contenido

Update a training quiz question

Módulo Workforce

PATCH/training-quiz-questions/{id}trainingQuizQuestions.update

A question of a quiz lesson; its correct option is a training quiz key that learners never read. 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.

  • Requiere la capacidad knowledge.sop.publish.
  • Alcances de OAuth: knowledge.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

trainingQuizQuestions.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the training quiz question.

Cuerpo de la solicitud: TrainingQuizQuestionUpdate

trainingQuizQuestions.update: TrainingQuizQuestionUpdate
CampoTipoObligatorioDescripción
positionintegerNoOrder, from 1.Restricciones: range 1 to any
promptstringNoQuestion text.Restricciones: length 1 to 500
optionsarray of stringNoAnswer options.
{
  "position": 1,
  "prompt": "What do you do before a lift?",
  "options": [
    "Inspect the sling",
    "Skip it"
  ]
}

Respuesta 200: TrainingQuizQuestion

trainingQuizQuestions.update: TrainingQuizQuestion
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the training quiz question.
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_lesson_idstring (uuid)SíIdentifier of the quiz lesson.
positionintegerSíOrder, from 1.Restricciones: range 1 to any
promptstringSíQuestion text.Restricciones: length 1 to 500
optionsarray of stringSíAnswer options.
{
  "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_lesson_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "position": 1,
  "prompt": "What do you do before a lift?",
  "options": [
    "Inspect the sling",
    "Skip it"
  ]
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/training-quiz-questions/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"position":1,"prompt":"What do you do before a lift?","options":["Inspect the sling","Skip it"]}'
const { data, etag } = await xos.trainingQuizQuestions.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "position": 1,
    "prompt": "What do you do before a lift?",
    "options": [
      "Inspect the sling",
      "Skip it"
    ]
  }, { ifMatch: etag });
response = xos.training_quiz_questions.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"position": 1, "prompt": "What do you do before a lift?", "options": ["Inspect the sling", "Skip it"]}, if_match=etag)
xos training-quiz-questions update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"position":1,"prompt":"What do you do before a lift?","options":["Inspect the sling","Skip it"]}' --if-match auto