Base de conocimientos BCdiplomaBase de conocimientos BCdiploma
Guía del usuario
Guía técnica
API
CGU y datos
  • English
  • Français
  • Español
Guía del usuario
Guía técnica
API
CGU y datos
  • English
  • Français
  • Español
  • API

    • Cómo utilizar la API de BCdiploma
    • Automatizar el proceso de emisión
    • Eliminaciones y desactivaciones
    • Actualización
    • Gestión de plantillas
    • Gestión de tablas de referencia
    • Gestión de rutas de aprendizaje
    • Descarga
    • Exportación de datos
    • Otras API
    • Gestión de errores

Gestión de tablas de referencia

Actualizar las entradas de una tabla de referencia

Consejos

Esta API requiere una clave API de gestión o de administrador.

Las tablas de referencia de una plantilla forman parte integrante de su definición JSON. Para simplificar su actualización, un endpoint dedicado permite transmitir únicamente las entradas nuevas o modificadas, en lugar de la totalidad del JSON de la plantilla.

Importante

La modificación de una entrada existente conlleva la actualización de todos los certificados ya emitidos que hacen referencia a esta clave.

La actualización se realiza mediante una llamada PUT al endpoint [API-URL]/template/tables.

Encabezado HTTP obligatorio: Content-Type: application/json

El cuerpo de la solicitud es un objeto JSON que contiene los siguientes campos obligatorios:

  • templateId: el identificador de la plantilla que contiene la tabla de referencia
  • references: la lista de entradas que se van a crear o reemplazar. Cada entrada se compone de:
    • table: el nombre de la tabla de referencia, tal como está definido en la plantilla (por ejemplo ref_formation)
    • key: la clave de la entrada, es decir, el valor utilizado en sus archivos de importación al crear sus campañas
    • definition: un objeto que contiene los valores asociados a la clave, para cada una de las columnas de la tabla
{
  "templateId": "1x04",
  "references": [
    {
      "table": "ref_formation",
      "key": "Digital Transformation",
      "definition": {
        "title_fr": "Transformation numérique",
        "title_en": "Digital Transformation"
      }
    },
    {
      "table": "ref_formation",
      "key": "Medical Statistics",
      "definition": {
        "title_fr": "Statistiques médicales",
        "title_en": "Medical Statistics"
      }
    }
  ]
}

Consejos

  • la tabla de referencia ya debe existir en la plantilla: esta llamada no la crea. Puede consultar la estructura de sus tablas de referencia recuperando la definición de la plantilla.
  • si la clave ya existe en la tabla, la entrada se reemplaza íntegramente por la nueva definición. Si la clave no existe, la entrada se añade.
  • la lista references puede contener tantas entradas como sea necesario, incluso para varias tablas de referencia de una misma plantilla.

Aviso

No se realiza ningún control sobre el contenido del objeto definition: una columna ausente o sobrante no genera ningún error. Asegúrese, por tanto, de indicar exactamente las columnas que espera la tabla de referencia.

Propagación al entorno de pruebas

Si su licencia incluye un entorno de pruebas (staging), lo que ocurre con todas las licencias salvo el plan Essentials, las actualizaciones de tablas de referencia realizadas en producción se replican en él automáticamente a intervalos regulares (cada hora).

Información

Durante esta propagación no se garantiza que se conserve el orden de aparición de las entradas en la tabla de referencia.

Prev
Gestión de plantillas
Next
Gestión de rutas de aprendizaje