API Reference

Filtros

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ásicosDescriçã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:

ComparadorDescrição
EqualEquivale a expressão: "é"
Valor padrão = 0
NotEqualEquivale a expressão: "não é"
Valor padrão = 1
LessEquivale a expressão: "é menor"
Valor padrão = 2
LessOrEqualEquivale a expressão: "é menor ou igual"
Valor padrão = 3
GreaterEquivale a expressão "é maior"
Valor padrão = 4
GreaterOrEqualEquivale a expressão: "é maior ou igual"
Valor padrão = 5
BeginsWithEquivale a expressão: "começa com"
Valor padrão = 6
DoesNotBeginWithEquivale a expressão: "não começa com"
Valor padrão = 7
IsInEquivale a expressão: "contém"
Valor padrão = 8
IsNotInEquivale a expressão: "não contém"
Valor padrão = 9
EndsWithEquivale a expressão: "termina com"
Valor padrão = 10
DoesNotEndWithEquivale a expressão: "não termina com"
Valor padrão = 11
ContainsEquivale a expressão: "contém"
Valor padrão = 12
DoesNotContainsEquivale a expressão: "não contém"
Valor padrão = 13
IsEmptyEquivale a expressão: "está vazio"
Valor padrão = 14
IsNotEmptyEquivale a expressão: "não está vazio"
Valor padrão = 15
BetweenEquivale a expressão: "está entre"
Valor padrão = 16
DoesNotBetweenEquivale a expressão: "não está entre"
Valor padrão = 17