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

Automation Anywhere Automation 360

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

Содержимое

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

Запросить сведения об устройстве

  • Обновлено: 7/10/2020
    • Automation 360 v.x
    • Изучение
    • Рабочая область RPA

Запросить сведения об устройстве

Используйте этот API для получения списка устройств, доступных для bot развертывания.

Подготовка

Роли и лицензия
Вам необходимо пройти аутентификацию в качестве пользователя с помощью лицензии на использование автоматического бот-литнера.
  • URL-АДРЕС :
    http://<your_control_room_url>/v2/devices/list
  • Метод: ПОСТ
Поддерживаемые фильтруемые параметры:
id
Числовой идентификатор устройства.
  • Поле: id
  • Тип: целое число
{
  "filter": {
    "operator": "eq",
    "value": "7",
    "field": "id"
  }
}
Имя хоста
Имя зарегистрированного устройства.
  • Поле: Имя хоста
  • Тип: строка
{
  "filter": {
    "operator": "substring",
    "value": "AA",
    "field": "hostName"
  }
}
Идентификатор пользователя
Уникальный числовой идентификатор пользователя, связанного с зарегистрированным устройством.
  • Поле: Идентификатор пользователя
  • Тип: длинный
{
  "filter": {
    "operator": "eq",
    "value": "13",
    "field": "userId"
  }
}
статус
Состояние подключения устройства.
  • Поле: статус
  • Тип: строка
{
  "filter": {
     "operator": "eq",
     "value": "CONNECTED",
     "field": "status"
      }
}

Эта задача запрашивает список всех устройств с определенной строкой в параметре HOSTNAME и определенном состоянии устройства. Используйте список в ответе, чтобы определить, какие устройства подключены и доступны для запуска bots.

Процедура

  1. Используйте метод POST для создания идентификатора JSON Web Token. Добавьте сгенерированный маркер аутентификации в заголовок запроса.
  2. Выберите метод POST.
  3. Введите URL-адрес для API:
    https://<your_control_room_url>/v2/devices/list
  4. В теле запроса добавьте правила фильтрации, сортировки и разбиения на страницы, чтобы получить список устройств, которые требуется развернуть.
    Например, в этом теле запроса в качестве оператора и в поле состояния и имени хоста устройства в качестве фильтра требуемых результатов используются поля "и". Результаты будут отсортированы в порядке убывания на основании "статуса".
    {
      "sort": [
        {
          "field": "status",
          "direction": "desc"
        }
      ],
      "filter": {
        "operator": "and",
        "operands": [
          {
            "operator": "eq",
            "value": "CONNECTED",
            "field": "status"
          },
          {
            "operator": "substring",
            "value": "win",
            "field": "hostName"
          }
        ]
      },
      "fields": [
        
      ],
      "page": {
        "offset": 0,
        "total": 71,
        "totalFilter": 18,
        "length": 100
      }
    }
  5. Отправьте запрос.
    • В клиенте REST щелкните ОТПРАВИТЬ.
    • В интерфейсе Swagger нажмите выполнить.

    Ответный текст:

    Ответ возвращает сведения о двух устройствах, которые находятся в состоянии «подключено» и для которых имя хоста начинается с «WIN» на основе запрошенных критериев фильтра.
    {
      "page": {
        "offset": 0,
        "total": 71,
        "totalFilter": 7
      },
      "list": [{
        "id": "163",
        "type": "ATTENDED_BOT_RUNNER",
        "hostName": "winwlm-2",
        "userId": "",
        "userName": "",
        "status": "CONNECTED",
        "poolName": "",
        "fullyQualifiedHostName": "-",
        "updatedBy": "b2",
        "updatedOn": "2020-07-07T08:24:56.091061Z",
        "botAgentVersion": "12.1"
      }, {
        "id": "162",
        "type": "ATTENDED_BOT_RUNNER",
        "hostName": "winwlm-1",
        "userId": "",
        "userName": "",
        "status": "CONNECTED",
        "poolName": "",
        "fullyQualifiedHostName": "-",
        "updatedBy": "b1",
        "updatedOn": "2020-07-07T08:24:55.982047Z",
        "botAgentVersion": "12.1"
      }
    }

Дальнейшие действия

Идентификаторы устройств, полученные в ответе, можно использовать для развертывания на bots Bot Runners.
Отправить отзыв