Ознакомиться с документацией Automation Anywhere

Automation Anywhere Automation 360

Закрыть содержимое

Содержимое

Открыть содержимое

Фильтрация в теле запроса API

  • Обновлено: 2021/03/15

    Фильтрация в теле запроса API

    Фильтрация обеспечивает базовые условные запросы и управление страницами для обработки запросов API. Для фильтрации предусмотрено три основных компонента: Условия, сортировка и параметры разбиения на страницы.

    Общие сведения о фильтрах

    Основной фильтр

    Пользовательские фильтры для поиска одного условия или их можно завернуть в логические операнды И и ИЛИ. Фильтрация пользователей для простой условной оценки одного поля. Значения, используемые в фильтре, например оператор и поле, относятся к API, в котором они используются.

    Значения по умолчанию представлены в угловых скобках < >. Для каждого параметра используйте только одно значение.

    Однопараметрический фильтр
    {
      "filter": {
        "operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>",
        "field": "string",
        "value": "string"
      }
    }
    Двухпараметрический фильтр
    {
      "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"
          }
        ]
      }
    }
    Эксплуатации Описание Пример
    лев Меньше Количество lt 1500
    ле Меньше или равно Количество le 1500
    эквалайзер Равно Адрес электронной почты пользователя, eq first.last@aa.com
    не Не равно UserEmailAddress, NE first.last@aa.com
    ge Больше или равно CreatedDate utc ge 2021-03-15
    гт Больше Дата создания gt 2021-03-15
    и. И. Field1 eq 'abc' и Field2 eq 'def'
    или Или Field1 eq 'abc' или Field2 eq 'def'
    Стр.
    "page":{ 
        "offset":0,
        "length":0
    }
    Разбивка на страницы параметры правил
    • Смещение:

      Тип: Целое число

      Числовое значение, указывающее, как это сделать множество строк в таблице, которые фильтр начинает оценивать.

    • Длина

      Тип: Целое число

      Количество строк, возвращаемых за один раз страница результатов.

    Сортировка
     "sort": [
        {
          "field": "string",
          "direction": "<asc, desc>"
        }
    • Поле: Поле, по которому необходимо отфильтровать результаты. Это поле должно быть поддерживаемым фильтруемым. Поля, которые можно фильтировать, различаются в зависимости от API.
    • Направлении

      Тип: Перечисление [ desc, asc ]

      • asc = по возрастанию (от наименьшего до наибольшего, от 0 до 9, ОТ A до Z)
      • desc = убывающий (от самого большого до самого маленького, от 9 до 0, от Z до A)

    Примеры фильтров API

    Отправить отзыв