Назначение вкладки

На вкладке представлены методы API для работы с роботами и их запусками.

Список методов

Работа с роботами 

МетодОписаниеПример случая, при котором может быть использован метод
GET /api/v1/robot-packages/{id}Получение роботаПросмотр описания изменений у выбранной версии робота
GET /api/v1/robot-packages/allПолучение списка всех роботовВывод списка роботов для просмотра информации о них или для выбора при запуске
DELETE /api/v1/robot-packages/{id}Добавление робота в корзинуДобавление в корзину устаревшей версии робота
POST /api/v1/robot-packages/deleted/{id}/restoreВосстановление роботаВосстановление робота, которого случайно добавили в корзину
DELETE /api/v1/robot-packages/deleted/{id}Удаление робота из корзиныПолное удаление робота, ранее добавленного в корзину


Работа с запусками роботов

МетодОписаниеПример случая, при котором может быть использован метод
POST /api/v1/robots/startЗапуск роботаРучной запуск робота пользователем.
GET /api/v1/robots/{id}Получение запуска роботаПросмотр статуса выбранного запуска робота.
GET /api/v1/robotsПолучение списка запусков роботовПросмотр списка запусков роботов, которые сегодня завершились с ошибкой
PATCH /api/v1/robots/{id}/pauseПриостановка работы робота на паузуПользователю нужно что-то самостоятельно проверить на машине, где работает робот. Чтобы не прерывать всю работу робота, пользователь при останавливает его работу на паузу
PATCH /api/v1/robots/{id}/continueПродолжение работы роботаПользователь завершил нужные ему проверки, работе робота ничего не мешает и ее можно продолжить.
PATCH /api/v1/robots/{id}/stopЗавершение работы роботаПользователь понял, что робот работает некорректно и требуется вручную остановить его работу
GET /api/v1/robots/{id}/logs/download-tokenПолучение токена для скачивания файла с логом роботаСкачивание файла с логом выбранного запуска робота. Если робот еще выполняется, то файл будет содержать только те записи лога, которые уже сформирован по этому запуску. Если робот уже завершен, то файл будет содержать полный лог этого запуска.
GET /api/v1/robots/logs/download-file/{id}Скачивание файла с логом робота
POST /api/v1/robots/reportsПодготовка отчёта по запуску роботовПодготовка и скачивание файла с отчетом о завершенных запусках роботов (формируется на основе информации из раздела "История запусков").
GET /api/v1/robots/reports/{id}/stateПолучение статуса подготовки отчёта по запускам робота
GET /api/v1/robots/reports/{id}/download-tokenПолучение токена для скачивания отчета по запускам робота
GET /api/v1/robots/reports/download-file/{id}Получение отчёта по запускам робота
  • Нет меток