Filtros em um corpo de solicitação de API
A filtragem fornece consultas condicionais básicas e controle de página para processamento de solicitações de API. Existem três componentes básicos da filtragem: condições, classificação e parâmetros de paginação.
Veja a seguir uma representação da estrutura de filtragem JSON usada nas APIs do Automation Anywhere.
{
"filter": {
"operator": "NONE",
"operands": [
null
],
"field": "string",
"value": "string"
},
"sort": [
{
"field": "string",
"direction": "asc"
}
],
"page": {
"offset": 0,
"length": 0
}
}Noções básicas sobre filtros
- Filtro básico
-
Os filtros podem ser usados para pesquisar uma única condição ou podem ser encapsulados em operandos lógicos AND e OR. A filtragem pode ser uma avaliação condicional simples de um único campo. O operador, o campo e o valor usados em um filtro são específicos da API em que são usados.Nota: Os valores nos colchetes < > incluem uma lista de todos os valores potenciais. Deve haver apenas um valor para cada parâmetro.
- Filtro de parâmetro único
-
{ "filter": { "operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>", "field": "string", "value": "string" } } - Filtro de dois parâmetros
-
{ "filter": { "operator": "<and, or>", "operands": [ { "operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>", "field": "string", "value": "string" }, { "operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>", "field": "string", "value": "string" } ] } }
- Page (Página)
-
"page":{ "offset":0, "length":0 }Parâmetros de regras de paginação- Deslocamento:
Tipo: inteiro
O valor numérico que indica quantas linhas em uma tabela o filtro começa a avaliar.
- Comprimento
Tipo: inteiro
O número de linhas retornadas em uma única página de resultados.
- Deslocamento:
- Classificar
-
"sort": [ { "field": "string", "direction": "<asc, desc>" }
Exemplos de filtro de API
- Exemplo de filtro de gerenciamento de usuários
- Este filtro de exemplo é baseado nos campos e parâmetros da API de Gerenciamento de usuários. Esse filtro pesquisa o nome de login do usuário, o nome de usuário e o nome real do usuário, nome.
- Exemplo de filtro de gerenciamento de repositório
- Este filtro de exemplo é baseado nos campos e parâmetros da API de Gerenciamento de repositório. Este exemplo de filtro pesquisa o status e o nome do bot .
- Exemplo de filtro de resultados da lista de migração
- Este filtro de exemplo é baseado nos campos e parâmetros da API de migração. Esse filtro pesquisa migrações que contêm uma string específica no nome e foi iniciada, atualizada em, entre duas datas.