Recuperación de estructuras de tabla V4
Las llamadas V4 para recuperar la definición de una o todas las tablas de perfil o tablas personalizadas se pueden utilizar para descubrir las bases de datos en una licencia y familiarizarse con su estructura.
Lo más probable es que se trate de llamadas manuales realizadas al inicio de un proyecto.
De hecho, la API V4 sólo permite recuperar la definición de tablas, pero no crear nuevas tablas: la creación de tablas perfiladas y personalizadas sólo se puede realizar mediante operaciones V5, cuyo formato JSON difiere ligeramente.
Tablas de perfil
Recuperar todas las tablas de perfil
La llamada V4 para 'Obtener todas las tablas de perfiles' podría usarse para recuperar una lista de tablas de perfiles.
> GET /v4/entity/{entity}/table
Su respuesta fue sólo una lista de los nombres de las tablas de perfiles correspondientes, sin su definición.
Esta llamada se puede reemplazar por la operación V5 para 'Obtener una lista de tablas de perfiles'
> GET /profile-table-structure/v5/entities/{entity}/profile-tables
El cuerpo de la respuesta es mucho más completo, ya que incluye la definición completa de todas las tablas coincidentes.
El parámetro de consulta ?fields=name se puede utilizar para recuperar sólo el "nombre" de las tablas, como en la llamada V4.
Recuperar una tabla de perfil
Cuando se conoce el nombre de una tabla de perfil, era posible recuperar su definición con la llamada V4 para 'Obtener una tabla de perfil'.
> GET /v4/entity/{entity}/table/{profileTable}
Esto se puede reemplazar por la operación V5 para 'Obtener una tabla de perfil':
> GET /profile-table-structure/v5/entities/{entity}/profile-tables/{profileTableId}
La carga útil difiere ligeramente, la diferencia más notable es que los parámetros de "nombre" son los nombres técnicos de los campos, mientras que los nombres para mostrar se definen por separado en el objeto "displayOptions".
Tablas personalizadas
Recuperar todas las tablas personalizadas
La lista de tablas personalizadas se puede recuperar con la llamada V4 para 'Obtener una lista de tablas personalizadas'
> GET /v4/entity/{entity}/customTable
Su carga útil incluye la definición completa de las tablas correspondientes.
Puede ser reemplazado por la operación V5 para 'Obtener una lista de tablas personalizadas'
> GET /v5/entities/{entity}/custom-tables
Al igual que con las tablas de perfiles, la carga útil difiere ligeramente, con los nombres para mostrar definidos por separado en el objeto "displayOptions".
De más
- el parámetro "capacidades" ya no se muestra, porque las capacidades de la tabla se basan en su "tipo".
- la "primaryKey" y la "businessKey" de la carga útil V4 se reemplazan por el parámetro "primaryKeyAttribute".
Recuperar una tabla personalizada
La definición de una tabla personalizada particular se puede recuperar con la llamada V4 'Obtener una tabla':
> GET /v4/entity/{entity}/customTable/{customTable}
Puede ser reemplazado por la operación V5 'Obtener una tabla personalizada':
> GET /custom-table-structure/v5/entities/{entity}/custom-tables/{customTableId}
Se aplican las mismas notas sobre el formato que se documentan en el consejo anterior.
Momento
Las operaciones de V4 seguirán funcionando hasta diciembre de 2024.
Posteriormente, solo quedarán disponibles las operaciones V5.