Specification
| Atributo | Descrição | Tipo |
|---|---|---|
| attributes | Lista de atributos a serem retornados na resposta da API | Array de strings |
| includes | Relacionamentos adicionais a serem incluídos na resposta | Objeto com chaves e arrays |
| filters | Filtros a serem aplicados aos recursos retornados pela API | Objeto contendo critérios de filtragem |
| sort | Campo pelo qual os resultados devem ser ordenados | String ou null |
| count | Indica se a resposta deve incluir a contagem total de recursos disponíveis | Booleano |
| limit | Número máximo de recursos a serem retornados em uma única chamada | Inteiro |
| page | Número da página a ser recuperada | Inteiro |
| search | Termo de pesquisa para buscar recursos com base em um critério de pesquisa geral | String ou null |
Operadores de Filtros
A API Public suporta uma variedade de operadores de filtro que podem ser aplicados a diferentes tipos de dados. Esses operadores facilitam a consulta e a obtenção de resultados mais específicos ao realizar requisições que envolvem filtros. Abaixo está uma lista dos operadores disponíveis, organizados por tipo de dado:
String
eq(Equal): Igual a.neq(Not Equal): Diferente de.ilk(Il-like): Semelhante a uma substring.ew(Ends With): Termina com.sw(Starts With): Começa com.
Número
eq(Equal): Igual a.neq(Not Equal): Diferente de.gt(Greater Than): Maior que.gte(Greater Than or Equal): Maior ou igual a.lt(Less Than): Menor que.lte(Less Than or Equal): Menor ou igual a.btw(Between): Dentro do intervalo (inclusive).nbtw(Not Between): Fora do intervalo.
Booleano
eq(Equal): Igual a.neq(Not Equal): Diferente de.
Data
eq(Equal): Igual a.neq(Not Equal): Diferente de.gt(Greater Than): Maior que.gte(Greater Than or Equal): Maior ou igual a.lt(Less Than): Menor que.lte(Less Than or Equal): Menor ou igual a.btw(Between): Dentro do intervalo (inclusive).nbtw(Not Between): Fora do intervalo.
Enumeração
in(In): Valor está dentro do conjunto.nin(Not In): Valor não está dentro do conjunto.
Utilize esses operadores ao construir seus filtros para refinar as consultas e obter resultados mais precisos.