Comportamiento al ejecutar GET en APIs de Tipo Entidad cuando se aplica la utilización de filtros
La API Filters permite buscar cualquier selector del Diccionario de Datos al ejecutar el método GET.
En este caso se toma como ejemplo el Diccionario de Datos “Proveedor” de la Entidad “Proveedores”.
Dentro del Diccionario “Proveedor”, en la sección de “Selectores” se encuentran las queries que se ejecutan en el GET cuando se usa la API.
Comportamiento al ejecutar GET
-
Acceder al Diccionario de Datos desde Menú → Configuración → Diseño del espacio de trabajo → Datos.
-
Seleccionar el Diccionario de Datos “Proveedor”
-
Ir a la solapa “Selectores”: aquí se encuentran las queries que se ejecutan a través de la API. El orden de ejecución es el siguiente:
- Ejecuta la query “Selector para Reportes”
- Si “Selector para Reportes” no existe, ejecuta la query “Selector para Edición”
- En la sección “Campos” se pueden agregar los campos de la Entidad “Proveedores” como filtros.
- Ir a la solapa “Selectores Adicionales”: sirven para completar una query personalizada. Si se configuran, la API primero intenta ejecutar los selectores adicionales (antes de los principales que están en la solapa “Selectores”), siguiendo el orden mencionado en el punto 1 y 2.
Importante: en la sección “Campos” es posible configurar múltiples filtros; sin embargo, en el parámetro “filtroString”, al ejecutar la API, solo se podrá utilizar un filtro por cada ejecución.
Parámetros
-
filtroString: admite un solo valor y corresponde a los filtros configurados en el diccionario de datos, en la seccion “Campos” de la solapa “Selectores”.
-
access_token: autenticación que permite poder consumir una API. Más información en obtener token.
-
camposAdicionales: admite más de un valor y trae los campos de la Entidad.
-
diccAlias: corresponde al código del diccionario de datos que se quiere ejecutar.
Pasos a seguir
- Ingresar a Postman
- Completar los parámetros.
- En “filtroString” utilizaremos CUIT previamente configurado en el Diccionario de Datos,
- Para “camposAdicionales” en Postman seleccionaremos para que devuelva todos los campos de la Entidad Proveedores con asterisco (*)
- En diccAlias utilizaremos el codigo “PROVEEDOR”
- Al ejecutar la API vemos que retorna el Proveedor corresponde al CUIT ingresado en el parámetro “filtroString”.
- Si se agregan valores específicos para el parámetro “camposAdicionales” vemos que retorna la información correspondiente para ese Proveedor, según lo definido en el parámetro.
