Conteúdo

Em rotas paginadas é possível fazer a filtragem e ordenação dos campos através de query params:

CampoDescriçãoObs
filtersParametrização da busca (apenas affiliate)opcional
sortOrdenação (apenas affiliate)opcional
pagePágina de busca, default: 1, min: 1opcional
sizeTamanho da busca, default: 10, max: 100opcional

Query Param: sort

Faz a ordenação da busca, no formato: sort=fieldName: asc ou desc

Query Param: filters

Monta um objeto de busca no banco de dados baseado nos campos fornecidos

Exemplo: filters=fieldName:operator:value;fieldName:isnull;...

fieldName Representa o campo no banco de dados
operator Operação a ser realizada
value String, número ou lista :value, :'value', :value1,value2,value3 ou :'value1,value2,value3'


Operadores:

ValorFunção
eqIGUAL
neqNÃO IGUAL (Diferente)
gtMAIOR QUE
gteMAIOR QUE OU IGUAL
ltMENOR QUE
inMENOR QUE OU IGUAL
ninNÃO INSERIDO EM
isnullNULO
isnotnullNÃO NULO

Exemplos:

eq: fieldName:eq:value
neq: fieldName:neq:value
gt: fieldName:gt:value
gte: fieldName:gte:value
lt: fieldName:lt:value
lte: fieldName:lte:value
in: fieldName:in:value,value,value
nin: fieldName:nin:value,value,value
isnull: fieldName:isnull
isnotnull: fieldName:isnotnull

FieldNames

São os campos disponíveis para aplicação dos filtros e ordenação.

GET - /affiliates
  • filters = [offer, credDate, tradeName, docNumber]
  • sort = [fantasyName]