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

Automation Anywhere Automation 360

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

Содержимое

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

Запланировать bot запуск API

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

Запланировать bot запуск API

Запланируйте запуск в bot автоматическом режиме Bot Runner как один раз, так и на регулярной основе.

Подготовка

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

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

Параметр Требуется Тип Описание
Идентификатор файла Да Номер Идентификатор для . bot Список файлов и папок по API рабочего пространства
RunAsUserIds Да Номер Идентификатор пользователя, который зарегистрирован в системе Control Room как пользователь-участник программы-робота без присмотра. Список доступных API- Bot Runners интерфейсов без участия оператора
статус Да Строка Указывает, нужно ли создавать активное или черновой расписание. Введите активный или ЧЕРНОВИК.
SpoolIds Нет Номер Идентификатор пула устройств, в котором имеется хотя бы одно активное устройство.
Прим.: Если пользователю, связанному Bot Runner с лицензией, назначено устройство по умолчанию для своей учетной записи, развертывается на bot этом устройстве. Если устройство по умолчанию не назначено или требуется выбрать другое устройство, необходимо указать пул устройств.
Перечислите API пулов устройств

Процедура

  1. Добавьте маркер аутентификации в заголовок запроса.
  2. Используйте метод POST и URL-адрес конечной точки: <control_room_url>/v1/schedule/automations.
    Тело запроса:
    В этом примере тело запроса содержит параметры, необходимые для однократного запуска по расписанию. bot
    {
       "name":"UpdateInventory.20.12.16.10.40.48",
       "fileId":"14277",
       "poolIds":[
          "27"
       ],
       "timeZone":"Asia/Calcutta",
       "runAsUserIds":[
          "472",
          "480",
          "80"
       ],
       "startDate":"2020-12-16",
       "startTime":"15:00",
       "scheduleType":"NONE",
       "status":"ACTIVE"
       }
    В этом примере тело запроса содержит параметры, необходимые для планирования повторного bot запуска.
    {
       "name":"UpdateInventory.20.12.16.10.40.48",
       "fileId":"14277",
       "poolIds":[
          "27"
       ],
       "timeZone":"Australia/Melbourne",
       "runAsUserIds":[
          "1103",
          "36",
          "80"
       ],
       "startDate":"2020-12-16",
       "repeatOccurrence":{
          "endTime":"23:59",
          "runEvery":"1",
          "timeUnit":"HOURS"
       },
       "repeatEnabled":true,
       "endDate":"2020-12-24",
       "startTime":"20:45",
       "weeklyRecurrence":{
          "interval":"1",
          "daysOfWeek":[
             "TUE",
             "THU",
             "FRI"
          ]
       },
       "scheduleType":"WEEKLY",
       "status":"ACTIVE"
    }
  3. Отправьте запрос.
    Ответный орган: Два примера ответов включают следующую информацию об автоматизации:
    • id: числовое значение, определяющее автоматизацию. Используйте этот параметр в API-интерфейсах автоматического обновления или удаления.
    • ZonedNextRunDTime: Дата и время следующего запуска, bot когда запланировано.
    Это пример ответа для bot запланированного однократного запуска.
    {
        "id": "989",
        "name": "UpdateInventory.20.12.16.10.40.48",
        "fileId": "14277",
        "status": "ACTIVE",
        "deviceIds": [],
        "description": "",
        "rdpEnabled": false,
        "scheduleType": "NONE",
        "timeZone": "Asia/Calcutta",
        "startDate": "2021-12-16",
        "endDate": "",
        "startTime": "15:00",
        "repeatEnabled": false,
        "zonedNextRunDateTime": "2021-12-16T09:30:00Z",
        "createdBy": "1103",
        "createdOn": "2021-01-11T18:57:18.932407Z",
        "updatedBy": "1103",
        "updatedOn": "2021-01-11T18:57:18.932422Z",
        "tenantId": "1",
        "fileName": "appsheet",
        "filePath": "Automation Anywhere\\Bots\\appsheet",
        "runAsUserIds": [
            "480",
            "80",
            "472"
        ],
        "botInput": {},
        "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
        "poolId": [
            "11"
        ],
        "overrideDefaultDevice": false,
        "runElevated": false
    }
    Это пример ответа для запланированного bot запуска на периодической основе.
    {
        "id": "990",
        "name": "UpdateInventory.20.12.16.10.40.48",
        "fileId": "14277",
        "status": "ACTIVE",
        "deviceIds": [],
        "description": "",
        "rdpEnabled": false,
        "scheduleType": "WEEKLY",
        "weeklyRecurrence": {
            "interval": 1,
            "daysOfWeek": [
                "TUE",
                "THU",
                "FRI"
            ]
        },
        "timeZone": "Australia/Melbourne",
        "startDate": "2021-01-16",
        "endDate": "2021-12-24",
        "startTime": "20:45",
        "repeatEnabled": true,
        "repeatOccurrence": {
            "runEvery": "1",
            "timeUnit": "HOURS",
            "endTime": "23:59"
        },
        "zonedNextRunDateTime": "2021-01-19T09:45:00Z",
        "createdBy": "1103",
        "createdOn": "2021-01-11T18:59:31.182663Z",
        "updatedBy": "1103",
        "updatedOn": "2021-01-11T18:59:31.182669Z",
        "tenantId": "1",
        "fileName": "a_trigger",
        "filePath": "Automation Anywhere\\Bots\\a_trigger",
        "runAsUserIds": [
            "80",
            "36",
            "1103"
        ],
        "botInput": {},
        "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
        "poolId": [
            "7"
        ],
        "overrideDefaultDevice": false,
        "runElevated": false
    } 
    API-интерфейс REST отвечает на каждый запрос с помощью кода ответа HTTP. Коды ответа см. Коды отклика APIв разделе .

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

Используйте для Перечислить API расписаний автоматизации получения сведений обо всех запланированных автоматах.
Отправить отзыв