Cómo agregar diccionarios de datos

Cómo agregar diccionarios de datos

Resumen

Los diccionarios de datos permiten mejorar la documentación de los métodos de las APIs y además agregan capacidades extendidas sobre ellos.


Configurar diccionarios de datos

Para configurar el diccionario de datos de un método, debe acceder al método y hacer clic sobre el botón Agregar o editar.



Se mostrará una ventana con columnas que le permitirán definir el nombre, descripción y tipo para cada una de las columnas de la vista de datos relacionada al método.



El nombre debe relacionarse al nombre del atributo que está referenciando en el diccionario de datos y el tipo al tipo de dato entregado..

No es necesario que complete todas las columnas, puede agregar diccionario solo sobre alguna de ellas.

Capacidades extendidas

Al agregar un diccionario de datos, en la ventana de Probar método del portal para desarrolladores visualizará opciones extendidas para aplicar filtros, agrupaciones y cálculos.

Estas opciones quedan a disposición del usuario desarrollador para ser utilizadas, sin afectar la configuración de la API.



Las opciones disponibles:




    • Related Articles

    • Orígenes de datos desde Bases de datos

      Resumen El conector a Bases de datos ofrece todas las capacidades necesarias para conectarse a este tipo de orígenes. Esta opción permite recolectar datos desde diferentes tipos de bases de datos o configurar acciones de escritura, para luego crear ...

    • Qué es una vista de datos

      Resumen La plataforma no requiere de un proceso ETL off-line para extraer los datos desde los orígenes, sino que asociadas a la vista se encuentran un conjunto de reglas que el motor de datos interpreta para consultar la fuente a demanda o ...

    • Orígenes de datos desde servicios web REST/json

      Resumen El conector a servicios web REST/JSON ofrece todas las capacidades necesarias para conectarse a este tipo de orígenes. Esta opción permite recolectar datos desde servicios web REST/JSON o configurar acciones de escritura, para luego crear ...

    • Seleccionar datos y cabeceras

      Resumen Las vistas de datos permiten seleccionar los datos y definir las cabeceras o títulos que estarán disponibles en los métodos de las APIs. Es posible realizar selecciones de la tabla completa, columnas, intersecciones de columnas y filas. ...

    • Orígenes de datos desde URLs

      Resumen El conector de URLs permite recolectar datos desde protocolos HTTP(s) y FTP. Para recolectar datos desde un archivo alojado en una URL, debes ir a Orígenes de Datos → Desde URLs Configuración Ingresar una URL con un  enlace válido desde donde ...