Saltar al contenido

Get a training completion

Módulo Workforce

GET/training-completions/{id}trainingCompletions.get

A training attempt with its quiz score; a pass carries a certificate number and expiry. Returns one training completion with its `ETag`. A training completion the caller may not see returns 404.

  • Requiere la capacidad knowledge.sop.read.
  • Alcances de OAuth: knowledge.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

trainingCompletions.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the training completion.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Respuesta 200: TrainingCompletion

trainingCompletions.get: TrainingCompletion
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the training completion.
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.
membership_idstring (uuid)SíIdentifier of the learner.
score_percentinteger | nullSíQuiz score in percent.Restricciones: range 0 to any
passedbooleanSíWhether the attempt passed.
completed_atstring (date-time)SíWhen the attempt finished.
expires_atstring (date-time) | nullSíWhen the pass stops being current.
certificate_numberstring | nullSíCompletion certificate number.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
certification_holder_idstring (uuid) | nullSíIdentifier of the certification record a verifier issued.
{
  "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",
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "score_percent": 90,
  "passed": true,
  "completed_at": "2026-10-08T14:30:00Z",
  "expires_at": "2026-10-08T14:30:00Z",
  "certificate_number": "TRN-0001",
  "certification_holder_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/training-completions/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.trainingCompletions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.training_completions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos training-completions get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f