En las API de Checklist, existe la posibilidad de utilizar filtros de apoyo para realizar las consultas. Para cada recurso (una ruta disponible en la API), la documentación lista los filtros aceptados y sus respectivos formatos de uso.
Parámetros de filtro aceptados
Examinemos, por ejemplo, el listado de unidades. Según la documentación, los filtros disponibles son:
- name: para filtrar por el nombre registrado de la unidad.
- unitTypeId: para filtrar introduciendo un identificador de tipo de unidad.
- active: para informar el status del registro (ej: filtrar sólo por unidades desactivadas).
- page: para indicar la página de resultados que se solicita.
- limit: para informar el número de registros que regresarán en la consulta.
Atención: el parámetro "limit" tiene un máximo de 100 registros por página. Es posible bajar este número, pero no aumentarlo.
Uso de Query Strings en la API
Cada vez que se realiza un filtro en la API, se informa como una Query String (cadena de consulta), que es una parte de la solicitud HTTP utilizada para enviar parámetros al servidor.
Ejemplos de filtrado en Postman
En Postman, el uso de Query Strings se gestiona fácilmente a través de la pestaña Params (Query params). Veamos dos ejemplos comunes:
1. Consulta de unidades activas:
2. Consulta de la segunda página de unidades activas:
❓Tem dúvidas? Entre em contato com nosso time de suporte.