API
API OneBridge поддерживает HTTPS-протоколы. В API OneBridge используются GET-, POST-, PATCH- и DELETE-запросы.
Каждый запрос начинается с URL http://<host>
, за ним следует название метода и параметры, при необходимости. Например, запрос для получения информации о запуске графа может быть записан так: http://127.0.0.1:3000/api/runs/154
или https://onebridge-dev.dev.allbridge.ru/api/runs/154
. В таблицах с описанием методов будут указаны относительные пути URL-запросов.
Список API-методов системы OneBridge, доступных для вызова:
Resources
get info
Параметр | Значение |
---|---|
Описание | Просмотр основной информации о сервере |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
get performance
Параметр | Значение |
---|---|
Описание | Просмотр данных о работе сервера для отображения графиков работы памяти, процессора и запущенных заданий |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа | возвращает JSON файл со структурой, которая содержит объекты, описывающие состояние памяти, процессора и запущенных заданий:
ram: объект с информацией о памяти
cpu: объект с информацией о процессоре
job: объект с информацией о запущенных заданиях
|
Пример ответа |
|
get utilization
Параметр | Значение |
---|---|
Описание | Просмотр данных о количестве используемой памяти сервера |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
Execution
get job params
Параметр | Значение |
---|---|
Описание | Просмотр параметров задания |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
get run by id
Параметр | Значение |
---|---|
Описание | Просмотр информации о запуске задания по id |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
get runs
Параметр | Значение |
---|---|
Описание | Просмотр списка заданий |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
get runs in progress
Параметр | Значение |
---|---|
Описание | Просмотр списка запущенных на данный момент заданий |
Метод | GET |
URL запроса |
|
Параметры запроса | Без параметров |
Структура ответа |
|
Пример ответа |
|
post runs
Параметр | Значение |
---|---|
Описание | Запускает задание в работу и возвращает номер запущенного задания |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Пример запроса |
|
Структура ответа |
|
Пример ответа |
|
get run position
Параметр | Значение |
---|---|
Описание | Просмотр позиции запуска |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
get runs log
Параметр | Значение |
---|---|
Описание | Просмотр логов запуска |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа | log: string |
Пример ответа |
|
get runs num
Параметр | Значение |
---|---|
Описание | Количество запусков заданий. Можно добавить фильтр по статусу, дате и имени файла |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
get job content
Параметр | Значение |
---|---|
Описание | Просмотр содержимого файла задания, актуального на момент его запуска |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
get run stats
Параметр | Значение |
---|---|
Описание | Просмотр статистики по запуску |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
abort run
Параметр | Значение |
---|---|
Описание | Прерывает выполнение задания |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
get runs inspect
Параметр | Значение |
---|---|
Описание | Возвращает данные о записях, прошедших по указанному ребру. |
Метод | GET |
URL запроса |
|
Параметры запроса | edge:string (id ребра) |
Структура ответа |
|
Пример ответа |
|
encrypt
Параметр | Значение |
---|---|
Описание | Шифрует значение параметра. |
Метод | POST |
URL запроса |
|
Параметры запроса | plaintext:string (значение параметра) |
Структура ответа |
|
Пример ответа |
|
Projects
get tree
Параметр | Значение |
---|---|
Описание | Просмотр дерева проектов |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
get directory
Параметр | Значение |
---|---|
Описание | Просмотр информации об указанной директории |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
get project
Параметр | Значение |
---|---|
Описание | Просмотр информации о проекте |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
get file
Параметр | Значение |
---|---|
Описание | Просмотр информации о выбранном файле |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
post project
Параметр | Значение |
---|---|
Описание | Создать проект |
Метод | POST |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
post project rename
Параметр | Значение |
---|---|
Описание | Переименовать проект |
Метод | POST |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
post directory
Параметр | Значение |
---|---|
Описание | Создать директорию |
Метод | POST |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
post directory rename
Параметр | Значение |
---|---|
Описание | Изменить название директории |
Метод | POST |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
post file
Параметр | Значение |
---|---|
Описание | Создать файл |
Метод | POST |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
post file rename
Параметр | Значение |
---|---|
Описание | Переименовать файл |
Метод | POST |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
patch file
Параметр | Значение |
---|---|
Описание | Заменить контент файла |
Метод | PATCH |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
delete directory
Параметр | Значение |
---|---|
Описание | Удалить директорию |
Метод | DELETE |
URL запроса |
|
Параметры запроса |
|
Структура ответа | ничего не возвращает |
delete file
Параметр | Значение |
---|---|
Описание | Удалить файл |
Метод | DELETE |
URL запроса |
|
Параметры запроса |
|
Структура ответа | ничего не возвращает |
delete project
Параметр | Значение |
---|---|
Описание | Удалить проект |
Метод | DELETE |
URL запроса |
|
Параметры запроса |
|
Структура ответа | ничего не возвращает |
get download folder
Параметр | Значение |
---|---|
Описание | Скачать папку |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа | Возвращает содержимое выбранной папки в виде zip-архива. |
Schedules
get schedules
Параметр | Значение |
---|---|
Описание | Просмотреть список расписаний |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
get schedule by id
Параметр | Значение |
---|---|
Описание | Выбор расписания по id |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
get schedules num
Параметр | Значение |
---|---|
Описание | Количество расписаний |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
get schedules position
Параметр | Значение |
---|---|
Описание | Позиция расписания по id |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
post schedules
Параметр | Значение |
---|---|
Описание | Создать расписание |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Структура ответа |
|
Пример ответа |
|
post toggle schedules
Параметр | Значение |
---|---|
Описание | Изменить состояние расписания (вкл/выкл) |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
delete schedules
Параметр | Значение |
---|---|
Описание | Удалить расписание |
Метод | DELETE |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа | ничего не возвращает |
patch schedules
Параметр | Значение |
---|---|
Описание | Изменить атрибуты расписания |
Метод | PATCH |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Структура ответа |
|
Пример ответа |
|
Event listeners
get event listeners
Параметр | Значение |
---|---|
Описание | Просмотр списка обработчиков событий |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
get event listener by id
Параметр | Значение |
---|---|
Описание | Выбор обработчика событий по id |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
get event listeners num
Параметр | Значение |
---|---|
Описание | Получить количество расписаний |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
get event listeners position
Параметр | Значение |
---|---|
Описание | Получить позицию расписания по его id |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
post event listeners
Параметр | Значение |
---|---|
Описание | Создает обработчик событий |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Структура ответа |
|
toggle event listeners
Параметр | Значение |
---|---|
Описание | Изменить состояние обработчика событий (вкл/выкл) |
Метод | POST |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
delete event listeners
Параметр | Значение |
---|---|
Описание | Удалить обработчик событий |
Метод | DELETE |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа | ничего не возвращает |
patch event listeners
Параметр | Значение |
---|---|
Описание | Изменить значения атрибутов обработчика событий |
Метод | PATCH |
URL запроса |
|
Тело запроса |
Все поля опциональные. Но при смене типа события event с "job" на "file" и наоборот, а так же при смене действия action с "Command" на "StartJob" и наоборот - нужно заполнить все сопутствующие атрибуты.
Например, если обработчик был настроен на event "job", и нужно заменить его на event "file", то нужно будет задать значение и для атрибутов filesystem, check, path, interval.
|
Структура ответа |
|
Пример ответа |
|
Auth
login
Параметр | Значение |
---|---|
Описание | Авторизация пользователя в системе |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Структура ответа |
|
Пример ответа |
|
logout
Параметр | Значение |
---|---|
Описание | Завершение сеанса работы в системе |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа | ничего не возвращает |
refresh
Параметр | Значение |
---|---|
Описание | Обновление токена |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
change password
Параметр | Значение |
---|---|
Описание | Смена пароля |
Метод | POST |
URL запроса |
|
Тело запроса |
|
Структура ответа | ничего не возвращает |
Users
post user
Параметр | Значение |
---|---|
Описание | Создание пользователя |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Структура ответа |
|
Пример ответа |
|
post toggle user status
Параметр | Значение |
---|---|
Описание | Изменение статуса пользователя |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
post reset user password
Параметр | Значение |
---|---|
Описание | Сброс пароля пользователя |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
patch user
Параметр | Значение |
---|---|
Описание | Редактирование данных пользователя. Поменять можно полное имя (fullname) и email |
Метод | PATCH |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Структура ответа | ничего не возвращает |
get user by id
Параметр | Значение |
---|---|
Описание | Просмотр информации о пользователе |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
get users
Параметр | Значение |
---|---|
Описание | Просмотр списка пользователей |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
Roles
get roles
Параметр | Значение |
---|---|
Описание | Просмотр списка ролей |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
get role
Параметр | Значение |
---|---|
Описание | Просмотр конкретной роли по её id |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
post role
Параметр | Значение |
---|---|
Описание | Создание роли |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Пример ответа | ничего не возвращает |
patch role
Параметр | Значение |
---|---|
Описание | Редактирование роли |
Метод | PATCH |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Пример ответа | ничего не возвращает |
delete role
Параметр | Значение |
---|---|
Описание | Удаление роли |
Метод | DELETE |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа | ничего не возвращает |
get privileges
Параметр | Значение |
---|---|
Описание | Просмотр списка всех существующих привилегий |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
get role privileges
Параметр | Значение |
---|---|
Описание | Просмотр привилегий роли |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
patch role privileges
Параметр | Значение |
---|---|
Описание | Обновление привилегий роли |
Метод | PATCH |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Структура ответа | ничего не возвращает |
get role subroles
Параметр | Значение |
---|---|
Описание | Просмотр субролей роли по её id |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
patch role subroles
Параметр | Значение |
---|---|
Описание | Изменение субролей роли |
Метод | PATCH |
URL запроса |
|
Тело запроса |
|
Структура ответа | ничего не возвращает |
get user roles
Параметр | Значение |
---|---|
Описание | Просмотр ролей конкретного пользователя |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
patch user roles
Параметр | Значение |
---|---|
Описание | Обновление ролей пользователя |
Метод | PATCH |
URL запроса |
|
Тело запроса |
|
Структура ответа | ничего не возвращает |
get user privileges
Параметр | Значение |
---|---|
Описание | Просмотр привилегий пользователя |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
patch user privileges
Параметр | Значение |
---|---|
Описание | Обновление привилегий пользователя |
Метод | PATCH |
URL запроса |
|
Тело запроса |
|
Структура ответа | ничего не возвращает |
get version
Параметр | Значение |
---|---|
Описание | Возвращает актуальную версию сборки приложения |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|