Leia e revise a documentação do Automation Anywhere

Automation Anywhere Automation 360

Fechar conteúdo

Contents (Conteúdo)

Abrir conteúdo

Filtros em um corpo de solicitação de API

  • Atualizado: 9/21/2020
    • Automation 360 v.x
    • Gerenciar
    • Espaço de trabalho RPA
    • Documentos de API

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
  }
}
A parte mais básica desse objeto JSON é a matriz de filtro.

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.

Classificar
 "sort": [
    {
      "field": "string",
      "direction": "<asc, desc>"
    }
  • Campo: O campo pelo qual você deseja que os resultados sejam filtrados. Deve ser um campo filtrável compatível. Os campos filtráveis variam dependendo da API.
  • Direção

    Tipo: Enum [ desc, asc ]

    • asc = ascendente (menor para maior, 0 a 9, A a Z)
    • desc = descendente (maior para menor, 9 a 0, Z a A)

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.
Send Feedback (Enviar Feedback)