Saltar al contenido

Update a training quiz key

Módulo Workforce

PATCH/training-quiz-keys/{id}trainingQuizKeys.update

The correct option of a quiz question. Only course editors read it. 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

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

Cuerpo de la solicitud: TrainingQuizKeyUpdate

trainingQuizKeys.update: TrainingQuizKeyUpdate
CampoTipoObligatorioDescripción
correct_optionintegerNoCorrect option, from 1.Restricciones: range 1 to any
{
  "correct_option": 1
}

Respuesta 200: TrainingQuizKey

trainingQuizKeys.update: TrainingQuizKey
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the training quiz key.
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_quiz_question_idstring (uuid)SíIdentifier of the quiz question.
correct_optionintegerSíCorrect option, from 1.Restricciones: range 1 to any
{
  "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_quiz_question_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "correct_option": 1
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/training-quiz-keys/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 '{"correct_option":1}'
const { data, etag } = await xos.trainingQuizKeys.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "correct_option": 1
  }, { ifMatch: etag });
response = xos.training_quiz_keys.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"correct_option": 1}, if_match=etag)
xos training-quiz-keys update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"correct_option":1}' --if-match auto