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

Automation Anywhere Automation 360

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

Содержимое

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

Развертывание bots API

  • Обновлено: 3/08/2021
    • Automation 360 v.x
    • Управление
    • Рабочая область RPA

Развертывание bots API

Как пользователь с Bot Runner лицензией развертывайте bots на назначенных устройствах. Также можно передавать переменные в при bots развертывании.

Подготовка

Прим.: Можно просмотреть в Control Room APIs , Community Editionно функциональность API ограничена. Для Automation 360 доступа к полной функциональности API-интерфейсов требуется лицензированная версия.
Убедитесь, что вам выделены следующие ресурсы:
  • Просмотр и запуск функций ботов
  • Запустите и запланируйте разрешения для папок, содержащих bots
  • Доступ к Bot Runner лицензированным пользователям
  • Доступ к устройству по умолчанию или пулу устройств
    Прим.: Если пользователю, связанному Bot Runner с лицензией, назначено устройство по умолчанию для своей учетной записи, развертывается на bot этом устройстве. Если устройство по умолчанию не назначено или требуется выбрать другое устройство, необходимо указать пул устройств.

Чтобы развернуть и bot передать значение переменной в , botнеобходимо предоставить API следующую информацию:

Параметр Требуется Тип Описание
Идентификатор файла Да Номер Идентификатор для развертываемых. bot

Список файлов и папок по API рабочего пространства

RunAsUserIds Да Номер Идентификатор пользователя, который зарегистрирован в системе Control Room как пользователь-участник программы-робота без присмотра.

Список доступных API- Bot Runners интерфейсов без участия оператора

SpoolIds Нет Номер Идентификатор пула устройств, в котором имеется хотя бы одно активное устройство. При вводе нескольких идентификаторов пула введите значения в том порядке, в котором API должен проверять наличие доступных устройств. Если ни одно из устройств не доступно во время развертывания, автоматизация ставится в очередь.
Прим.: Если пользователю, связанному Bot Runner с лицензией, назначено устройство по умолчанию для своей учетной записи, развертывается на bot этом устройстве. Если устройство по умолчанию не назначено или требуется выбрать другое устройство, необходимо указать пул устройств.

Перечислите API пулов устройств

OverrideDefaultDevice Нет Логическое значение Если Bot Runner пользователю назначено устройство по умолчанию и требуется указать пул устройств, установите для этого параметра значение true.

При развертывании на устройстве по умолчанию установите для этого параметра значение false.

BotInput Нет Меняется Укажите имя входной переменной, значение и тип данных.
NumOfRunAsUsersToUse Нет Номер Указывает, сколько Bot Runners из списка runAsUserIdsбудет использоваться . Взвешенный системный алгоритм выбирает с Bot Runners наименьшим количеством задач в очереди.
CallbackInfo Нет Объект Предоставляет URL-адрес и маркер аутентификации для сервера обратного вызова. После bot развертывания отправляет Control Room значения состояния развертывания и выходных переменных на этот сервер обратных вызовов.

Процедура

  1. Добавьте маркер аутентификации в заголовок запроса.
  2. Используйте метод POST и URL-адрес конечной точки: <your_control_room_url>/v3/automations/depy.

    Тело запроса:

    В этом примере тело запроса указывает требуемые параметры, а также значение входной переменной.
    {
      "fileId": 14277,
      "runAsUserIds": [
        2538
      ],
      "botInput": {
        "sDocHello": {
          "type": "STRING",
          "string": "Hello world, go be great."
        }
      }
    }
    В этом примере тело запроса указывает четыре runAsUserIds и два numOfRunAsUsersToUse. Взвешенный алгоритм выбирает две Bot Runners задачи с наименьшим количеством задач, поставленных в очередь во время запроса на развертывание.
    {
      "fileId": 14277,
      "runAsUserIds": [
        2538,
        4256,
        2213,
        789
      ],
       "poolIds": [
        27
      ],
      "numOfRunAsUsersToUse": 2
    }
    В этом примере тело запроса содержит значение true для параметра overrideDefaultDevice , поэтому будет развернуто bot в пуле устройств вместо устройства по умолчанию пользователя Run-as. В этом примере также содержится синтаксис для указания URL-адреса сервера обратного вызова и предоставления авторизации.
    {
      "fileId": 14277,
      "runAsUserIds": [
        245
      ],
       "poolIds": [
        27
      ],
      "overrideDefaultDevice": true,
      "callbackInfo": {
        "url": "https://callbackserver.com/storeBotExecutionStatus",
        "headers": {
          "X-Authorization": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiI0Ii"
        }
      }
    }
  3. Отправьте запрос.

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

    После успешного Bot выполнения API-интерфейс развертывания возвращает ответ с идентификатором развертывания.
    {
      "deploymentId": "14c2b6f8-c2a0-4a57-959d-ef413df0d179"
    }
    API-интерфейс REST отвечает на каждый запрос с помощью кода ответа HTTP. Коды ответа см. Коды отклика APIв разделе .

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

Выполните эту задачу: Запросить API состояния развертывания бот.

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