API
В API OneBridge используются POST-, GET-, PATCH- и DELETE-запросы. Тип запроса указан в таблице для каждого метода.
Каждый URL начинается с http://<host:port>
, за этим следует название метода и параметры, при необходимости. Например, запрос для получения информации о запуске графа может быть записан так: http://127.0.0.1:3000/api/run-by-id?id=14
. В таблицах с описанием методов будут указаны относительные пути URL-запросов.
Список API-методов системы OneBridge, доступных для вызова:
- API
- Auth
- Users
- create user
- toggle user status
- reset user password
- update user
- view user
- list users
- Roles
- view all roles
- view role
- create role
- update role
- delete role
- view all privileges
- view all assigned privileges
- view role privilegies
- update role privilegies
- view all assigned subroles
- view role subroles
- update role subroles
- view all assigned roles
- view user roles
- update user roles
- view all assigned privileges
- view user privileges
- update user privileges
- Resources
- Execution
- Projects
- Schedules
- Event listeners
Auth
login
Параметр | Значение |
---|---|
Описание | Логин |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Структура ответа |
|
Пример ответа |
|
logout
Параметр | Значение |
---|---|
Описание | Логаут |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа | ничего не возвращает |
refresh
Параметр | Значение |
---|---|
Описание | Рефреш токена |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
change password
Параметр | Значение |
---|---|
Описание | Смена пароля |
Метод | POST |
URL запроса |
|
Тело запроса |
|
Структура ответа | ничего не возвращает |
Users
create user
Параметр | Значение |
---|---|
Описание | Создание пользователя |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Структура ответа |
|
Пример ответа |
|
toggle user status
Параметр | Значение |
---|---|
Описание | Изменение статуса пользователя |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
reset user password
Параметр | Значение |
---|---|
Описание | Сброс пароля пользователя |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
update user
Параметр | Значение |
---|---|
Описание | Обновление пользователя. Поменять можно first_name, last_name, email |
Метод | PATCH |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Структура ответа | ничего не возвращает |
view user
Параметр | Значение |
---|---|
Описание | Просмотр пользователя |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
list users
Параметр | Значение |
---|---|
Описание | Просмотр списка пользователей |
Метод | GET |
URL запроса |
|
Параметры запроса | Без параметров |
Структура ответа |
|
Пример ответа |
|
Roles
view all roles
Параметр | Значение |
---|---|
Описание | Просмотр списка ролей |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
view role
Параметр | Значение |
---|---|
Описание | Просмотр конкретной роли по её id |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
create role
Параметр | Значение |
---|---|
Описание | Создание роли |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Пример ответа | ничего не возвращает |
update role
Параметр | Значение |
---|---|
Описание | Обновление роли |
Метод | PATCH |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Пример ответа | ничего не возвращает |
delete role
Параметр | Значение |
---|---|
Описание | Удаление роли |
Метод | DELETE |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа | ничего не возвращает |
view all privileges
Параметр | Значение |
---|---|
Описание | Просмотр списка всех существующих привилегий |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
view role assigned privileges
Параметр | Значение |
---|---|
Описание | Просмотр привилегий роли |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
view role privileges
Параметр | Значение |
---|---|
Описание | Просмотр привилегий роли |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
update role privileges
Параметр | Значение |
---|---|
Описание | Обновление привилегий роли |
Метод | PATCH |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Структура ответа | ничего не возвращает |
view all assigned subroles
Параметр | Значение |
---|---|
Описание | Просмотр всех присвоенных ролям субролей |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
view role subroles
Параметр | Значение |
---|---|
Описание | Просмотр субролей роли |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
update role subroles
Параметр | Значение |
---|---|
Описание | Изменение субролей роли |
Метод | PATCH |
URL запроса |
|
Тело запроса |
|
Структура ответа | ничего не возвращает |
view all assigned roles
Параметр | Значение |
---|---|
Описание | Просмотр списка ролей, присвоенных каждому пользователю |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
view user roles
Параметр | Значение |
---|---|
Описание | Просмотр ролей конкретного пользователя |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
update user roles
Параметр | Значение |
---|---|
Описание | Обновление ролей пользователя |
Метод | PATCH |
URL запроса |
|
Тело запроса |
|
Структура ответа | ничего не возвращает |
view all privileges
Параметр | Значение |
---|---|
Описание | Просмотр всех присвоеннных пользователям привилегий |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
view user assigned privileges
Параметр | Значение |
---|---|
Описание | Просмотр привилегий пользователя |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
update user privileges
Параметр | Значение |
---|---|
Описание | Обновление привилегий пользователя |
Метод | PATCH |
URL запроса |
|
Тело запроса |
|
Структура ответа | ничего не возвращает |
Resources
get info
Параметр | Значение |
---|---|
Описание | Просмотр основной информации о сервере |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
get performance
Параметр | Значение |
---|---|
Описание | Возвращает данные о работе сервера для отображения графиков работы памяти и процессора |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа | возвращает JSON файл со структурой, которая содержит объекты, описывающие состояние памяти и процессора:
ram: объект с информацией о памяти
cpu: объект с информацией о процессоре
|
Пример ответа |
|
get utilization
Параметр | Значение |
---|---|
Описание | Возвращает данные о количеству используемой памяти сервера |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
Execution
get runs
Параметр | Значение |
---|---|
Описание | Возвращает информацию об отработавшем задании |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
post runs
Параметр | Значение |
---|---|
Описание | запускает задание в работу и возвращает номер запущенного задания |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Структура ответа |
|
Пример ответа |
|
get run position
Параметр | Значение |
---|---|
Описание | Просмотр данных о запуске задания |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
get run by id
Параметр | Значение |
---|---|
Описание | Возвращает информацию об отработавшем задании |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
get runs log
Параметр | Значение |
---|---|
Описание | Возвращает журнал выполнения запуска задания |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа | log: string |
Пример ответа |
|
get runs num
Параметр | Значение |
---|---|
Описание | Возвращает количество запусков заданий. Можно добавить фильтр по статусу, дате и имени файла |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
get run job content
Параметр | Значение |
---|---|
Описание | Возвращает контент указанного задания, акутального на момент запуска |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
get run stats
Параметр | Значение |
---|---|
Описание | Возвращает статистику об указанном запуске |
Метод | GET |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа |
|
Пример ответа |
|
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 запроса |
|
Параметры запроса |
|
Структура ответа | ничего не возвращает |
Schedules
get schedules
Параметр | Значение |
---|---|
Описание | Просмотреть список расписаний |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
post schedules
Параметр | Значение |
---|---|
Описание | Создать расписание |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Структура ответа |
|
Пример ответа |
|
post schedules toggle
Параметр | Значение |
---|---|
Описание | Изменить состояние расписания (вкл/выкл) |
Метод | POST |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
post schedules rename
Параметр | Значение |
---|---|
Описание | Изменить название расписания |
Метод | POST |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
delete schedule
Параметр | Значение |
---|---|
Описание | Удалить расписание |
Метод | DELETE |
URL запроса |
|
Параметры запроса | без параметров |
Структура ответа | ничего не возвращает |
patch schedules
Параметр | Значение |
---|---|
Описание | Изменить атрибуты расписания |
Метод | PATCH |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Структура ответа |
|
Пример ответа |
|
Event listeners
get event listeners
Параметр | Значение |
---|---|
Описание | Возвращает список обработчиков событий |
Метод | GET |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
post event listeners
Параметр | Значение |
---|---|
Описание | Создает обработчик событий |
Метод | POST |
URL запроса |
|
Параметры запроса | без параметров |
Тело запроса |
|
Структура ответа | ничего не возвращает |
post event listeners toggle
Параметр | Значение |
---|---|
Описание | Изменить состояние обработчика событий (вкл/выкл) |
Метод | POST |
URL запроса |
|
Параметры запроса |
|
Структура ответа |
|
Пример ответа |
|
post event listeners rename
Параметр | Значение |
---|---|
Описание | Изменить название обработчика событий |
Метод | 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.
|
Структура ответа |
|
Пример ответа |
|