Specification
| Atributo | Descripción | Tipo |
|---|---|---|
| attributes | Lista de atributos a ser devuelta en la respuesta de la API | Array de strings |
| includes | Relaciones adicionales a ser incluidas en la respuesta | Objeto con claves y arrays |
| filters | Filtros a aplicar a los recursos devueltos por la API | Objeto que contiene criterios de filtrado |
| sort | Campo por el cual los resultados deben ser ordenados | String o nulo |
| count | Indica si la respuesta debe incluir el conteo total de recursos disponibles | Booleano |
| limit | Número máximo de recursos a ser devuelto en una sola llamada | Entero |
| page | Número de página a ser recuperado | Entero |
| search | Término de búsqueda para buscar recursos basados en un criterio de búsqueda general | String o nulo |
Operadores de Filtro
La API Pública soporta una variedad de operadores de filtro que pueden aplicarse a diferentes tipos de datos. Estos operadores facilitan la consulta y obtención de resultados más específicos al realizar solicitudes que involucran filtros. A continuación, se presenta una lista de operadores disponibles, organizados por tipo de datos:
String
eq(Equal): Igual a.neq(Not Equal): No igual a.ilk(Il-like): Similar a una substring.ew(Ends With): Termina con.sw(Starts With): Comienza con.
Número
eq(Equal): Igual a.neq(Not Equal): No igual a.gt(Greater Than): Mayor que.gte(Greater Than or Equal): Mayor o igual que.lt(Less Than): Menor que.lte(Less Than or Equal): Menor o igual que.btw(Between): Dentro del rango (inclusivo).nbtw(Not Between): Fuera del rango.
Booleano
eq(Equal): Igual a.neq(Not Equal): No igual a.
Fecha
eq(Equal): Igual a.neq(Not Equal): No igual a.gt(Grater Than): Mayor que.gte(Greater Than or Equal): Mayor o igual que.lt(Less Than): Menor que.lte(Less Than or Equal): Menor o igual que.btw(Between): Dentro del rango (inclusivo).nbtw(Not Between): Fuera del rango.
Enumeración
in(In): El valor está dentro del conjunto.nin(Not In): El valor no está dentro del conjunto.