Veja como realizar uma requisição utilizando os filtros do Atendare
Através dos filtros na API, é possível realizar a limitação dos resultados com base em critérios específicos enviados pela query da requisição.
Conceitos básicos | Descrição |
---|---|
Campo 'field' | Essa expressão recebe o nome do campo que será filtrado |
Condição 'condition' | Utilizado para combinar vários filtros usando operadores lógicos como 'AND' e 'OR'. |
Operadores 'operation' | Realizam a comparação entre valores da expressões (listados abaixo) |
Valor 'value' | Campo que recebe o valor a ser comparado e filtrado na expressã |
Veja abaixo um exemplo utilizando o campo de 'creation_date' filtrando pela data entre os dias 27-07-2022 e 29-07-2022:
{
"condition": "Or|And", - condição entre as regras
"rules": [ - a lista de condições aplicando a regra acima
{
"condition": "Or|And", - sub condição entre as regras
"conditions": [ - a lista de condições aplicando a regra acima
{
"field": "creation_date",
"operation": "Between", - Operação a ser realizada
"value": "[\"2022-07-27T16:52-03:00\",\"2022-07-29T16:52-03:00\"]"
},
-- Pode-se adicinar mais
},
-- Pode-se adicinar mais
]
}
Operadores de comparação
Nos filtros do Atendare, você pode comparar dois valores ou pesquisar por uma característica específica em um campo determinado.
A seguir, estão as opções de comparação e seus IDs correspondentes:
Comparador | Descrição |
---|---|
Equal | Equivale a expressão: "é" Valor padrão = 0 |
NotEqual | Equivale a expressão: "não é" Valor padrão = 1 |
Less | Equivale a expressão: "é menor" Valor padrão = 2 |
LessOrEqual | Equivale a expressão: "é menor ou igual" Valor padrão = 3 |
Greater | Equivale a expressão "é maior" Valor padrão = 4 |
GreaterOrEqual | Equivale a expressão: "é maior ou igual" Valor padrão = 5 |
BeginsWith | Equivale a expressão: "começa com" Valor padrão = 6 |
DoesNotBeginWith | Equivale a expressão: "não começa com" Valor padrão = 7 |
IsIn | Equivale a expressão: "contém" Valor padrão = 8 |
IsNotIn | Equivale a expressão: "não contém" Valor padrão = 9 |
EndsWith | Equivale a expressão: "termina com" Valor padrão = 10 |
DoesNotEndWith | Equivale a expressão: "não termina com" Valor padrão = 11 |
Contains | Equivale a expressão: "contém" Valor padrão = 12 |
DoesNotContains | Equivale a expressão: "não contém" Valor padrão = 13 |
IsEmpty | Equivale a expressão: "está vazio" Valor padrão = 14 |
IsNotEmpty | Equivale a expressão: "não está vazio" Valor padrão = 15 |
Between | Equivale a expressão: "está entre" Valor padrão = 16 |
DoesNotBetween | Equivale a expressão: "não está entre" Valor padrão = 17 |