Skip to Content

Informes API

Qué convierte un informe de Flex en informe de API, las columnas que el servidor le añade y cuáles se sincronizan con PG Sync.

Un informe API es un informe ordinario con categoría Funcionalidad y subcategoría API. El servidor le añade las columnas que necesitan el SDK y la caché, y PG Sync lo copia si es sincronizable.

Qué lo convierte en informe de API

La pareja Funcionalidad y API. Se crea como cualquier informe en FlexHub → Informes. Pasar la categoría a Funcionalidad exige consolidar (NeedsConsolidation); al consolidar, el servidor añade estas columnas ocultas:

Columna automáticaQué es
idEl identificador del registro.
fechaiaEl índice de actividad del registro, en UTC. Es la marca con la que se sincroniza.
eliminadoLa baja lógica.

No se pueden borrar: la consolidación las vuelve a poner. La pestaña API de FlexHub agrupa toda la categoría Funcionalidad; el botón Con nombre de API fuera de Funcionalidad señala los que se llaman «API» sin esa categoría, que no reciben estas columnas.

FlexHub, Informes: las pestañas Negocio, API y Todos, y el botón Con nombre de API fuera de Funcionalidad con 3 informes
1: la pestaña API, con toda la categoría Funcionalidad. 2: los informes que se llaman «API» sin esa categoría.

Sincronizables con PG Sync

PG Sync copia a PostgreSQL los informes API que cumplen todo esto:

  • No está eliminado ni obsoleto.
  • No tiene preguntas.
  • Todas sus columnas son campos directos de la sección, entre ellas id y fechaia.

Vale la columna Cliente de una venta (el identificador de la relación); no vale Cliente > Nombre. Un informe con relaciones, agrupaciones, algoritmos o preguntas se ejecuta igual por la API, pero no se sincroniza.

Consumir el informe

POST /api/reports?id=<GUID> ejecuta el informe y devuelve sus filas en JSON. Parámetros, cuerpo y respuesta: Informes y documentos por la API. Con safeColumnsName=true las columnas se nombran por su GUID y renombrar un campo no rompe la integración. Desde .NET, los métodos de informes del Cliente Dinaup.

Cambiar un informe que ya consume alguien

Un sistema conectado lee el informe por el nombre o el GUID de sus columnas.

  • Añadir una columna no rompe ninguna integración.
  • Cambiar o quitar una columna rompe las que la leen. Crea un informe nuevo y deja el viejo hasta que nadie lo use.
  • Renombrar el informe cambia su palabra clave y su tabla en PG Sync.

En esta página