...
1. Поиск робота, которого нужно запустить
Необходимо выполнить запрос на получение списка роботов
| Запрос | GET https://<адрес вашего сервера>:9443/orchestrator/api/v1/robot-packages/all?pageNumber=<номер страницы>&pageSize=<количество записей>&name=<название робота> |
|---|
| Заголовки | Authorization: Bearer <ваш токен доступа> |
|---|
| Раскрыть |
|---|
|
Запрос на получение списка роботов- Обязательные параметры запроса:
- pageNumber - номер страницы.
- pageSize - максимальное количество записей (роботов) на указанной странице. Если у робота несколько версий, то каждая версия имеет свою отдельную запись на странице.
(подробнее о работе этих параметров см. в Получение списков). - Дополнительно можно указать параметр "name" для уточнения названия искомого робота.
| Раскрыть |
|---|
| GET https://test-ent.rpa-robin.site:9443/orchestrator/api/v1/robot-packages/all?pageNumber=1&pageSize=10&name=Робот для отчета |
|
Ответ на запросИз ответа получаем значение параметра "id" - идентификатор робота. Дополнительно можно взять параметры: - parameters - содержит входные параметры робота.
- requireUiThread - признак, требует ли робот наличия UI-сессии на учётной записи машины.
| Раскрыть |
|---|
| { "items": [ { "id": "c2d64bc2-c99f-4824-bf3c-c965f5809c1a", "uuid": null, "contract": "S_web_Robot_dlya_otcheta", "version": "1.0.1", "createDateTime": "2026-03-11T20:43:29+03:00", "publishDateTime": "2026-03-11T20:43:29.240614+03:00", "createAuthor": "Головлева А. Д.", "name": "Робот для отчета", "title": "Робот для отчета", "description": "Робот для составления отчета", "names": { "ru-RU": "Робот для отчета" }, "descriptions": { "ru-RU": "Робот для составления отчета" }, "changes": "Добавили действия для отправки отчета", "requireUiThread": true, "impInfoXml": "<ImplementationInfo version=\"1.0.1\" contract...", "storages": [], "childCount": null, "parentId": null, "parentSourceId": null, "parameters": [ { "name": "Папка с документами", "type": "Robin.FolderPath", "title": null, "description": null, "required": false }, { "name": "ФИО ответственного", "type": "Robin.String", "title": null, "description": null, "required": false } ], "results": [], "averageDuration": null, ... } ], "pageNumber": 1, "totalPages": 1, "totalItems": 1 } |
|
В ответ может вернуться несколько записей с роботами. Найти нужную запись можно по: - версии робота ("version"),
- его описанию ("description")
или - ,
- описанию изменений в его версии ("changes").
| Раскрыть |
|---|
| title | Пример ответа с несколькими записями |
|---|
| { "items": [ { "id": "c2d64bc2-c99f-4824-bf3c-c965f5809c1a", "uuid": null, "contract": "S_web_Robot_dlya_otcheta", "version": "1.0.1", "createDateTime": "2026-03-11T20:43:29+03:00", "publishDateTime": "2026-03-11T20:43:29.240614+03:00", "createAuthor": "Головлева А. Д.", "name": "Робот для отчета", "title": "Робот для отчета", "description": "Робот для составления отчета", "names": { "ru-RU": "Робот для отчета" }, "descriptions": { "ru-RU": "Робот для составления отчета" }, "changes": "Добавили действия для отправки отчета", "requireUiThread": true, ... }, { "id": "c8820b02-6d65-4022-9ca6-c32504d5684b", "uuid": null, "contract": "S_web_Robot_dlya_otcheta", "version": "1.0.0", "createDateTime": "2026-03-11T20:42:22+03:00", "publishDateTime": "2026-03-11T20:42:22.778898+03:00", "createAuthor": "Головлева А. Д.", "name": "Робот для отчета", "title": "Робот для отчета", "description": "Робот для составления отчета", "names": { "ru-RU": "Робот для отчета" }, "descriptions": { "ru-RU": "Робот для составления отчета" }, "changes": "1я версия", "requireUiThread": true, ... } ], "pageNumber": 1, "totalPages": 1, "totalItems": 2 } |
|
|
2. Поиск учётной записи машины, на которой нужно запустить робота
Необходимо выполнить запрос на получение списка учётных записей машин
| Запрос | GET https://<адрес вашего сервера>:9443/orchestrator/api/v1/hosts/host-users?pageNumber=<номер страницы>&pageSize=<количество записей>&search=<имя учётной записи> |
|---|
| Заголовки | Authorization: Bearer <ваш токен доступа> |
|---|
| Раскрыть |
|---|
|
Запрос на получение списка учётных записей машин- Обязательные параметры запроса:
- pageNumber - номер страницы.
- pageSize - максимальное количество записей (УЗ машин) на указанной странице.
(подробнее о работе этих параметров см. в Получение списков). - Дополнительно можно указать параметр "search" для уточнения имени искомой учётной записи.
| Раскрыть |
|---|
| GET https://test-ent.rpa-robin.site:9443/orchestrator/api/v1/hosts/host-users?pageNumber=1&pageSize=10&search=Huawei |
|
Ответ на запросИз ответа получаем значение параметра "id" - идентификатор учётной записи машины. | Раскрыть |
|---|
| { "items": [ { "id": "4c024d2c-e99d-4789-ba3f-5705e1c52305", "username": "LAPTOP-NO7H14PR\\Huawei", "host": { "id": "d1e77f6c-a0c0-481d-aaf5-5bdd422df012", "hostname": "LAPTOP-NO7H14PR", "ip": "192.161.7.8", "os": "WINDOWS", "diskSpaceTotalKB": 495238246, "ramTotalKB": 16119104, "coresNumber": 6, "cpuLoadPercentage": null, "diskSpaceFreeKB": null, ... } ], "pageNumber": 1, "totalPages": 1, "totalItems": 1 } |
|
В ответ может вернуться несколько записей с учётными записями. Найти нужную запись можно по: - имени машины ("hostname"),
- IP-адресу ("ip"),
- тегам ("tags")
или - ,
- описанию учётной записи ("description")
. А также по - ,
- имени учётной записи ("username"), если в запросе искали только по части имени.
| Раскрыть |
|---|
| title | Пример ответа с несколькими записями |
|---|
| { "items": [ { "id": "4c024d2c-e99d-4789-ba3f-5705e1c52305", "username": "LAPTOP-NO7H14PR\\Huawei", "host": { "id": "d1e77f6c-a0c0-481d-aaf5-5bdd422df012", "hostname": "LAPTOP-NO7H14PR", "ip": "192.161.7.8", "os": "WINDOWS", "diskSpaceTotalKB": 495238246, "ramTotalKB": 16119104, "coresNumber": 6, "cpuLoadPercentage": null, "diskSpaceFreeKB": null, "ramFreeKB": null }, "createDateTime": "2023-06-27T13:54:36.86242+03:00", "hasUiThread": false, "isOnline": false, "activeRobotCount": 0, "activeUiRobotCount": 0, "activeBackgroundRobotCount": 0, "tags": [ "для проверки роботов" ], "description": "Личный ноутбук", "software": "", ... }, { "id": "f9528ab5-8ccd-4865-b6ab-6b2010853fc1", "username": "WIN-TEST-01\\test", "host": { "id": "52c903ec-410a-483c-a565-b4b95c84c011", "hostname": "win-test-01", "ip": "10.63.7.14", "os": "WINDOWS", "diskSpaceTotalKB": 44854931, "ramTotalKB": 8387608, "coresNumber": 1, "cpuLoadPercentage": null, "diskSpaceFreeKB": null, "ramFreeKB": null }, "createDateTime": "2024-03-20T16:48:33.133505+03:00", "hasUiThread": false, "isOnline": false, "activeRobotCount": 0, "activeUiRobotCount": 0, "activeBackgroundRobotCount": 0, "tags": [], "description": "для тестирования", "software": null, ... } ], "pageNumber": 1, "totalPages": 1, "totalItems": 2 } |
|
|
3. Запуск робота| Запрос | POST https://<адрес вашего сервера>:9443/orchestrator/api/v1/robots/start |
|---|
| Заголовки | |
|---|
| Тело запроса | { "hostUserId": "<id учётной записи машины>", "robotPackageId": "<id робота>", "jsonParameters": [ { "name": "<название параметра>", "type": "<тип параметра>", "value": "<значение параметра>" }, { ... } ], "logLevel": "<название уровня логирования>", "allowParallelUiRobotSession": true } |
|---|
...
Запрос на запуск робота
- Обязательные параметры в теле запроса:
- hostUserId - идентификатор учётной записи машины, на которой будет запущен робот (получали в запросе №2).
- robotPackageId - идентификатор запускаемого робота (получали в запросе №1).
- Дополнительно можно указать параметры:
- jsonParameters - для указания входных параметров робота. Название параметра ("name") и его тип ("type") копируем из ответа на запрос №1 (из "parameters"). В "value" указываем значение входного параметра.
logLevel - уровень логирования, с которым будет запущен робот.
allowParallelUiRobotSession - определяет, может ли робот работать параллельно с другими UI-роботами на той же учётной записи машины. Имеет смысл указывать, если текущему роботу требуется UI-сессия (у робота параметр requireUiThread=true, см. запрос №1), а на указанной учётной записи уже работает UI-робот (или его запустят позже).
...
POST https://test-ent.rpa-robin.site:9443/orchestrator/api/v1/robots/start
...
Ответ на запрос
Из ответа может понадобится значение параметра "id". В нем указан идентификатор сессии робота, по которому можно остановить работу робота или поставить ее на паузу.
| Раскрыть |
|---|
|
Запрос- Обязательные параметры в теле запроса:
- hostUserId - идентификатор учётной записи машины, на которой будет запущен робот (получали в запросе №2).
- robotPackageId - идентификатор запускаемого робота (получали в запросе №1).
- Дополнительно можно указать параметры:
- jsonParameters - список входных параметров робота. Каждый параметр содержит поле "name","type"и "value". Название параметра и его тип копируем из ответа на запрос №1 (из "parameters"). В "value" указываем значение входного параметра.
logLevel - уровень логирования, с которым будет запущен робот. Возможные значения: BUSINESS, ROBOT_DEVELOPER, DEBUG, INFO, WARNING, ERROR, NONE. allowParallelUiRobotSession - определяет, может ли робот работать параллельно с другими UI-роботами на той же учётной записи машины. Имеет смысл указывать, если текущему роботу требуется UI-сессия (у робота параметр requireUiThread=true, см. запрос №1), а на указанной учётной записи уже работает UI-робот (или его запустят позже).
| Раскрыть |
|---|
| POST https://test-ent.rpa-robin.site:9443/orchestrator/api/v1/robots/start { "hostUserId": "4c024d2c-e99d-4789-ba3f-5705e1c52305", "robotPackageId": "c2d64bc2-c99f-4824-bf3c-c965f5809c1a", "jsonParameters": [ { "name": "Папка с документами", "type": "Robin.FolderPath", "value": "C:\\Users\\Huawei\\Desktop\\Материалы" }, { "name": "ФИО ответственного", "type": "Robin.String", "value": "Иванов И.И." } ], "logLevel": "ROBOT_DEVELOPER", "allowParallelUiRobotSession": true }
|
|
Ответ на запросИз ответа может понадобится "id" - идентификатор запуска робота, по которому можно остановить работу робота или поставить ее на паузу. | Раскрыть |
|---|
| { "id": "d6ff9f85-a7f5-44cd-9a97-6d94a6a0fa42", "createDateTime": "2026-03-12T00:03:52.510176456+03:00", "startDateTime": null, "stopDateTime": null, "pauseDateTime": null, "finishDateTime": null, ... } |
|
|
Управление запуском робота
1. Установка паузы
| Запрос | PATCH https://<адрес вашего сервера>:9443/orchestrator/api/v1/robots/<id запуска робота>/pause |
|---|
| Заголовки | Authorization: Bearer <ваш токен доступа> |
|---|
В URL указываем идентификатор запуска робота, который получаем при запуске робота.
Пример запроса:
PATCH https://test-ent.rpa-robin.site:9443/orchestrator/api/v1/robots/f5ad4368-8a13-4ef4-bd61-c70cbfba28e3/pause |
2. Снятие паузы
| Запрос | PATCH https://<адрес вашего сервера>:9443/orchestrator/api/v1/robots/<id запуска робота>/continue |
|---|
| Заголовки | Authorization: Bearer <ваш токен доступа> |
|---|
В URL указываем идентификатор запуска робота, который получаем при запуске робота.
Пример запроса:
PATCH https://test-ent.rpa-robin.site:9443/orchestrator/api/v1/robots/f5ad4368-8a13-4ef4-bd61-c70cbfba28e3/continue |
3. Завершение работы робота
| Запрос | PATCH https://<адрес вашего сервера>:9443/orchestrator/api/v1/robots/<id запуска робота>/stop |
|---|
| Заголовки | |
|---|
Тело запроса (необязательно) | { "type": "<Тип остановки>" } |
|---|
| Раскрыть |
|---|
|
- В URL указываем идентификатор запуска робота, который получаем при запуске робота.
- В теле запроса указываем параметр "type" - тип остановки робота. Возможные значения: NORMAL, SOFT, HARD.
| Раскрыть |
|---|
| PATCH https://test-ent.rpa-robin.site:9443/orchestrator/api/v1/robots/f5ad4368-8a13-4ef4-bd61-c70cbfba28e3/stop
{ "type": "HARD" } |
|
|
Получение лога робота
1. Поиск запуска робота
Необходимо выполнить запрос на получение списка запусков роботов
| Запрос | GET https://<адрес вашего сервера>:9443/orchestrator/api/v1/robots?pageNumber=<номер страницы>&pageSize=<количество записей> |
|---|
| Заголовки | Authorization: Bearer <ваш токен доступа> |
|---|
| Раскрыть |
|---|
|
Запрос- Обязательные параметры запроса:
- pageNumber - номер страницы.
- pageSize - максимальное количество записей (запусков роботов) на указанной странице.
(подробнее о работе этих параметров см. в Получение списков). - Дополнительно можно указать параметры:
- search - название искомого робота.
- states - статус искомого запуска. Возможные значения: CREATED, START_ERROR, RUNNING, PAUSING, PAUSED, STOPPING, STOPPED, NO_CONNECTION, FINISHED_WITH_SUCCESS, FINISHED_WITH_ERROR, UNKNOWN
| Раскрыть |
|---|
| GET https://test-ent.rpa-robin.site:9443/orchestrator/api/v1/robot-packages/all?pageNumber=1&pageSize=10&search=Робот для отчета&states=FINISHED_WITH_SUCCESS |
|
Ответ на запросИз ответа получаем "id" - идентификатор запуска робота. Также этот идентификатор можно получить, выполнив запрос на запуск робота. | Раскрыть |
|---|
| { "items": [ { "id": "68702188-1d5c-42a2-8e7f-96872a786c5b", "createDateTime": "2026-03-13T08:21:14.073374+03:00", "startDateTime": "2026-03-13T08:21:18.475811+03:00", "stopDateTime": null, "pauseDateTime": null, "finishDateTime": "2026-03-13T08:21:21.042913+03:00", "endDateTime": "2026-03-13T08:21:21.912876+03:00", "robotPackageId": null, "name": "Робот для отчета", ... } ], "pageNumber": 1, "totalPages": 24, "totalItems": 24 } |
|
В ответ может вернуться несколько записей с запусками. Найти нужную запись можно по: - дате начала запуска ("createDateTime"),
- дате окончания запуска ("finishDateTime"),
- версии робота ("version"),
- названию ("name") и типу инициатора запуска ("type"), указанные в параметре "initiator",
- имени машины ("hostname"),
- IP-адресу ("ip"),
- имени учётной записи ("username").
| Раскрыть |
|---|
| title | Пример ответа с несколькими записями |
|---|
| { "items": [ { "id": "68702188-1d5c-42a2-8e7f-96872a786c5b", "createDateTime": "2026-03-13T08:21:14.073374+03:00", "startDateTime": "2026-03-13T08:21:18.475811+03:00", "stopDateTime": null, "pauseDateTime": null, "finishDateTime": "2026-03-13T08:21:21.042913+03:00", "endDateTime": "2026-03-13T08:21:21.912876+03:00", "robotPackageId": null, "name": "Робот для отчета", "version": "1.0.1", "initiator": { "id": "c2b80d42-cf8c-4684-8469-8af71b16b623", "name": "Головлева А. Д.", "type": "MANUAL", "robot": null, "process": null, "typeName": null, "appType": "RMC", "ownerUserId": "c2b80d42-cf8c-4684-8469-8af71b16b623", "deleted": false }, "username": "LAPTOP-NO7H14PR\\Huawei", "companyName": null, "host": { "id": "d1e77f6c-a0c0-481d-aaf5-5bdd422df012", "hostname": "LAPTOP-NO7H14PR""ip": "10.255.255.1", "ip": "10.255.255.1", ... }, { "id": "f5ad4368-8a13-4ef4-bd61-c70cbfba28e3", "createDateTime": "2026-03-12T17:04:11.247801+03:00", "startDateTime": "2026-03-12T17:04:14.84003+03:00", "stopDateTime": null, "pauseDateTime": null, "finishDateTime": "2026-03-12T19:16:38.917532+03:00", "endDateTime": "2026-03-12T19:16:39.731865+03:00", "robotPackageId": null, "name": "Робот для отчета", "version": "1.0.1", "initiator": { "id": "c2b80d42-cf8c-4684-8469-8af71b16b623", "name": "Головлева А. Д.", "type": "MANUAL", "robot": null, "process": null, "typeName": null, "appType": "RMC", "ownerUserId": "c2b80d42-cf8c-4684-8469-8af71b16b623", "deleted": false }, "username": "LAPTOP-NO7H14PR\\Huawei""ip": "10.255.255.1", "companyName": null, "host": { "id": "d1e77f6c-a0c0-481d-aaf5-5bdd422df012", "hostname": "LAPTOP-NO7H14PR", "ip": "10.255.255.1", ... } ], "pageNumber": 1, "totalPages": 12, "totalItems": 24 } |
|
|
2. Подготовка файла лога
| Запрос | POST https://<адрес вашего сервера>:9443/orchestrator/api/v1/robots/<id запуска робота>/robot-logs |
|---|
| Заголовки | Authorization: Bearer <ваш токен доступа> |
|---|
| Раскрыть |
|---|
|
ЗапросВ URL указываем идентификатор запуска робота, который получили из запроса №1 (или запроса по запуску робота) Пример запроса: POST https://test-ent.rpa-robin.site:9443/orchestrator/api/v1/robots/68702188-1d5c-42a2-8e7f-96872a786c5b/robot-logs |
Ответ на запросИз ответа получаем: - token - токен для скачивания файла лога.
- objectId - идентификатор файла лога.
Пример ответа: { "token": "cBcEOrV7EVDKFpcvNxQ2grAIdROJ355vcLDWhdPU-tCiWW1AOCFlU5bis1G0_jYNTASFA20bQGeo482qPmZB6Y6bmVxYELXHagwlM8HeVCWDu4qTxgXJgi0IAt2YPMEWhcO4HEqnr3s9uQyPSfKu4GI2CX1Za4ujCI-lMiL4pzw", "objectId": "e8492545-5a7f-4729-9e04-2eca27f4f025" } |
|
3. Получение файла лога
| Запрос | GET https://<адрес вашего сервера>:9443/orchestrator/api/v1/robots/robot-logs/download-file/<id файла лога>?token=<токен файла лога> |
|---|
| Заголовки | Authorization: Bearer <ваш токен доступа> |
|---|
| Раскрыть |
|---|
|
Запрос- В URL указываем идентификатор файла лога (из запроса №2)
- В параметрах запроса указываем токен файла лога (из запроса №2).
Пример запроса: GET https://test-ent.rpa-robin.site |
|
...
...
{
"id": "d6ff9f85-a7f5-44cd-9a97-6d94a6a0fa42",
"createDateTime": "2026-03-12T00:03:52.510176456+03:00",
"startDateTime": null,
"stopDateTime": null,
"pauseDateTime": null,
"finishDateTime": null,
...
}Управление запуском робота
1. Установка паузы
...
:9443/orchestrator/api/v1/robots |
|
...
Authorization: Bearer <ваш токен доступа>
В URL указываем идентификатор сессии робота, который получаем при запуске робота.
Пример запроса:
...
/robot-logs/download-file/e8492545-5a7f-4729-9e04-2eca27f4f025?token=cBcEOrV7EVDKFpcvNxQ2grAIdROJ355vcLDWhdPU-tCiWW1AOCFlU5bis1G0_jYNTASFA20bQGeo482qPmZB6Y6bmVxYELXHagwlM8HeVCWDu4qTxgXJgi0IAt2YPMEWhcO4HEqnr3s9uQyPSfKu4GI2CX1Za4ujCI-lMiL4pzw |
Ответ на запросВ ответ приходит содержимое файла лога. Пример ответа: 2026-03-12T19:16:38.888+03:00 RobotDeveloper LAPTOP-NO7H14PR Robin.Engine 21400 {"message":"actionFinishMessage","actionExecutionTime":"00:00:03.8008679","robotId":" |
|
...
f5ad4368-8a13-4ef4-bd61-c70cbfba28e3 |
|
...
2. Снятие паузы
...
PATCH https://<адрес вашего сервера>:9443/orchestrator/api/v1/robots/<id сессии робота>/continue
...
Authorization: Bearer <ваш токен доступа>
В URL указываем идентификатор сессии робота, который получаем при запуске робота.
Пример запроса:
...
","actionNumber":null,"uniqueName":"Сообщение 2","actionId":"76326aa1-6952-4a0b-a8b2-48b1dfa98243"} 2026-03-12T19:16:35.087+03:00 RobotDeveloper LAPTOP-NO7H14PR Robin.Engine 21400 {"message":"actionStartMessage","robotId":"f5ad4368-8a13-4ef4-bd61-c70cbfba28e3 |
|
...
3. Завершение работы робота
...
PATCH https://<адрес вашего сервера>:9443/orchestrator/api/v1/robots/<id сессии робота>/stop
...
...
{
"type": "<Тип остановки>"
}| Раскрыть |
|---|
|
- В URL указываем идентификатор сессии робота, который получаем при запуске робота.
- В теле запроса указываем параметр "type" - тип остановки робота. Возможные значения:
- NORMAL - обычная остановка. Робот остановится после завершения текущего выполняющегося действия.
- SOFT - мягкая остановка. Робот продолжит выполнять действия до тех пор, пока не настанет очередь выполнить действия, на котором установлена точка мягкой остановки. Робот не выполнит это действие, а завершит свою работу.
- HARD - жесткая остановка. Робот остановится сразу, не завершив выполнение текущего действия.
| Раскрыть |
|---|
|
|
PATCH https://test-ent.rpa-robin.site:9443/orchestrator/api/v1/robots/","actionNumber":null,"uniqueName":"Сообщение 2","actionId":"76326aa1-6952-4a0b-a8b2-48b1dfa98243"} 2026-03-12T17:05:04.284+03:00 RobotDeveloper LAPTOP-NO7H14PR Robin.Engine 21400 {"message":"actionFinishMessage","actionExecutionTime":"00:00:49.3697817","robotId":"f5ad4368-8a13-4ef4-bd61-c70cbfba28e3","actionNumber":null,"uniqueName":"Сообщение 1","actionId":"10a8a854-88f2-4c8e-b4b0-b914187096ff"} 2026-03-12T17:04:14.927+03:00 RobotDeveloper LAPTOP-NO7H14PR Robin.Engine 21400 {"message":"actionStartMessage","robotId":"f5ad4368-8a13-4ef4-bd61-c70cbfba28e3 |
/stop
{
"type": "HARD"
","actionNumber":null,"uniqueName":"Сообщение 1","actionId":"10a8a854-88f2-4c8e-b4b0-b914187096ff"} |