На вкладке представлены методы 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} | Получение отчёта по запускам робота |