Tiempo estimado para lectura: 00:01:20 min
Duda
¿Cómo utilizar los filtros en la requisición de la API de Integración?
Ambiente
Cross Segmentos - TOTVS CRM Gestión de Clientes MI - API de Integración - Filtros en solicitud de la API de Integración - Todas las versiones
Solución
Para utilizar un filtro en solicitud de la API de Integración, basta agregar la llave Integration-Filter en header con el valor que desea filtrar, además de las otras llaves de request, como la imagen:
Note que, en este ejemplo, es realizada una request en servicio de oportunidades, una búsqueda por el código 61. De esta manera, la estrutura del filtro es la siguiente.
{campo->operador->valor}
Es necesario que sea agregada la operación dentro de las llaves. Si desea agregar más de un filtro, basta agregar un nuevo conjunto de llaves sin separación por comas, como en el ejemplo:
{code->eq->61}{status->eq->PROGRESS}
En este caso, el filtro traerá solamente la oportunidad del código igual a 61 y status igual a PROGRESS.
1. Operadores lógicos para utilizar en filtros:
1.1. Operadores de igualdad:
- isNull: testar si un campo no tiene un valor completado;
- eq: testar si un campo es igual a un valor constante;
- ne: testar si un campo no es igual a un valor constante.
1.2. Operadores de rango:
- gt: testar si un campo es mayor que un valor constante;
- lt: testar si un campo es menor que un valor constante;
- ge: testar si un campo es mayor o igual a un valor constante;
- le: testar si un campo es menor o igual a un valor constante;
- in: testar si un campo tiene valor igual a uno de los valores de la lista.
2. Campos de llave extranjera:
Para realizar un filtro por una llave extranjera, es necesario pasar la entidad y el campo a ser filtrado.
En el caso de oportunidades, hay el identificador de usuario que es regresado en el campo userld.
Sin embargo, para filtrar por un id especifico de un usuario, es necesario referenciar la tabla user y el campo id de la siguiente manera:
{user.id->eq->b69b712f-7bd6-357d-9cda-59959c89a2b1}
3. Utilizar in con una lista de valores:
Para utilizar un filtro in con una lista de valores, es necesario agregar los valores dentro de la estrutura [valores], de la siguiente manera:
{code->in->[61,62,63]}
OBSERVACIÓN: no puede tener espacios entre las comas y los valores.
4. Realizar filtro por un período de fecha.
Para filtrar por un período de fecha, es necesario agregar un filtro "mayor que" y otro de "menor que". Según los operadores listados anteriormente, el formato de fecha es el siguiente:
2020-06-30T13:26:32.163Z
Abajo un filtro de oportunidad creada entre los dias 29 e 30 de enero de 2020:
{createdAt->ge->2020-01-29T00:00:00.000Z}{createdAt->lt->2020-01-31T00:00:00.000Z}
5. Verificar si un campo esta nulo:
Para verificar si un campo esta nulo, basta agregar el operador isNull en el lugar del operador y valor, como el ejemplo:
{externalId->isNull}
Note que irá traer todas las oportunidades en que el campo externalId no fue completado. De esta manera, es posible trabajar con los campos para realizar los filtros necesarios en su solicitud.
Para más detalles acceda
0 Comentarios