Récupérer les Structures de Tables V4

Les appels V4 pour récupérer la définition d'un/de toutes les tables de profils ou tables personnalisées peuvent être utilisés pour découvrir les bases de données d'une licence et se familiariser avec leur structure.

Il s'agit très probablement d'appels manuels effectués au début d'un projet.

En effet, l'API V4 permet uniquement de récupérer la définition des tables, mais pas de créer de nouvelles tables : la création de tables de profil et personnalisées ne peut se faire qu'au travers d'opérations V5, dont le format JSON diffère légèrement.

Tables de profil

Récupérer toutes les tables de profils

L'appel V4 pour 'Get all profile tables' pouvait être utilisé pour récupérer une liste de tables de profils

> GET /v4/entity/{entity}/table

Sa réponse n'était qu'une liste des noms des tables de profils correspondantes, sans leur définition.

Cet appel peut être remplacé par l'opération V5 pour 'Get a list of profile tables'

> GET /profile-table-structure/v5/entities/{entity}/profile-tables

Le corps de la réponse est beaucoup plus complet, car il inclut la définition complète de toutes les tables correspondantes.

Le paramètre de requête ?fields=name peut être utilisé pour récupérer uniquement le "nom" des tables, comme dans l'appel V4.

Récupérer une table de profil

Lorsque le nom d'une table de profil est connu, il était possible de récupérer sa définition avec l'appel V4 pour 'Get a profile table'.

> GET /v4/entity/{entity}/table/{profileTable}

Ceci peut être remplacé par l'opération V5 pour 'Get a profile table':

> GET /profile-table-structure/v5/entities/{entity}/profile-tables/{profileTableId}

Astuce

Le payload diffère légèrement, la différence la plus notable étant que les paramètres "name" sont les noms techniques des champs, tandis que les noms d'affichage sont définis séparément dans l'objet "displayOptions".

Tables personnalisées

Récupérer toutes les tables personnalisées

La liste des tables personnalisées pouvait être récupérées avec l'appel V4 pour 'Get a list of custom tables'

> GET /v4/entity/{entity}/customTable

Son payload inclut la définition complète des tables correspondantes.

Il peut être remplacé par l'opération V5 pour 'Get a list of custom tables'

> GET /v5/entities/{entity}/custom-tables

Astuce

Comme pour les tables de profils, le payload diffère légèrement, avec les noms d'affichage définis séparément dans l'objet "displayOptions".

De plus

• le paramètre "capabilities" n'est plus affiché, car les capacités de la table sont basées sur son "type".
• les "primaryKey" et "businessKey" du payload V4 sont remplacées par le paramètre "primaryKeyAttribute".

Récupérer une table personnalisée

La définition d'une table personnalisée en particulier pouvait être récupérer avec l'appel V4 'Get a table':

> GET /v4/entity/{entity}/customTable/{customTable}

Il peut être remplacé par l'opration V5 'Get a custom table':

> GET /custom-table-structure/v5/entities/{entity}/custom-tables/{customTableId}

Les mêmes remarques sur le format que celles documentées dans l'astuce ci-dessus s'appliquent.

Timing

Les opérations V4 continueront à fonctionner jusqu'en décembre 2024.

Par la suite, seules les opérations V5 resteront disponible.