Base de connaissances BCdiplomaBase de connaissances BCdiploma
Guide utilisateur
Guide technique
API
CGU et données
  • English
  • Français
  • Español
Guide utilisateur
Guide technique
API
CGU et données
  • English
  • Français
  • Español
  • API

    • Comment utiliser l'API BCdiploma
    • Automatiser le processus d'émission
    • Suppressions et désactivations
    • Mise à jour
    • Gestion des modèles
    • Gestion des tables de référence
    • Gestion des parcours
    • Téléchargement
    • Exportation de données
    • Autres API
    • Gestions des erreurs

Gestion des tables de référence

Mettre à jour les entrées d'une table de référence

Conseil

Cette API nécessite une clé d'API gestion ou administrateur.

Les tables de référence d'un modèle font partie intégrante de sa définition JSON. Pour simplifier leur mise à jour, un point de terminaison dédié permet de ne transmettre que les entrées nouvelles ou à modifier, plutôt que l'intégralité du JSON du modèle.

Important

La modification d'une entrée existante entraîne la mise à jour de tous les certificats déjà émis faisant référence à cette clé.

La mise à jour s'effectue via un appel PUT au point de terminaison [API-URL]/template/tables.

Entête HTTP obligatoire : Content-Type: application/json

Le corps de la requête est un objet JSON contenant les champs obligatoires suivants :

  • templateId : l'identifiant du modèle contenant la table de référence
  • references : la liste des entrées à créer ou à remplacer. Chaque entrée est composée de :
    • table : le nom de la table de référence, tel que défini dans le modèle (par exemple ref_formation)
    • key : la clé de l'entrée, c'est-à-dire la valeur utilisée dans vos fichiers d'import lors de la création de vos campagnes
    • definition : un objet contenant les valeurs associées à la clé, pour chacune des colonnes de la table
{
  "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"
      }
    }
  ]
}

Conseil

  • la table de référence doit déjà exister dans le modèle : elle n'est pas créée par cet appel. Vous pouvez consulter la structure de vos tables de référence en récupérant la définition du modèle.
  • si la clé existe déjà dans la table, l'entrée est intégralement remplacée par la nouvelle définition. Si la clé n'existe pas, l'entrée est ajoutée.
  • la liste references peut contenir autant d'entrées que nécessaire, y compris pour plusieurs tables de référence d'un même modèle.

Avertissement

Aucun contrôle n'est effectué sur le contenu de l'objet definition : une colonne manquante ou superflue ne génère pas d'erreur. Veillez donc à renseigner exactement les colonnes attendues par la table de référence.

Propagation vers l'environnement de recette

Si votre licence inclut un environnement de recette (staging), c'est-à-dire pour toutes les licences à l'exception du plan Essentials, les mises à jour de tables de référence effectuées en production y sont automatiquement répercutées à intervalles réguliers (toutes les heures).

Info

L'ordre d'apparition des entrées dans la table de référence n'est pas garanti lors de cette propagation.

Prev
Gestion des modèles
Next
Gestion des parcours