Kaiten

[PMO] База знаний функциональности (интернет)

To Kaiten

Описание чек-боксов ролей в RIC

СПИСОК ЭНДПОИНТОВ API (Расшифровка)

Модели

GET /models - Получить список всех моделей

GET /models/:id - Получить модель по ID

POST /models - Создать новую модель

DELETE /models/:id - Удалить модель по ID

POST /models/access - Управление доступом к моделям

DELETE /models/access - Удалить доступ к моделям

PATCH /models/:id - Обновить модель частично

POST /models/:id/nodes - Добавить узел в модель

PATCH /models/:id/nodes/:node - Обновить узел в модели

DELETE /models/:id/nodes/:node - Удалить узел из модели

POST /models/:id/nodes/:node/move - Переместить узел в модели

PATCH /models/:id/nodes - Обновить список узлов модели

GET /models/:id/arguments - Получить аргументы модели

GET /models/:id/commands - Получить команды модели

GET /models/:id/events - Получить события модели

GET /models/kits - Получить наборы (kits) моделей

Объекты

POST /objects - Создать новый объект

GET /objects/commands - Получить список команд для объектов

GET /objects/commands/:id - Получить команду по ID

POST /objects/commands - Создать команду для объекта

PATCH /objects/commands/:id - Обновить команду

DELETE /objects/commands/:id - Удалить команду

POST /objects/commands/access - Управление доступом к командам

DELETE /objects/commands/access - Удалить доступ к командам

GET /objects/packets - Получить пакеты (сообщения) объектов

GET /objects/:id - Получить объект по ID

GET /objects - Получить список объектов

POST /objects/access - Управление доступом к объектам

DELETE /objects/access - Удалить доступ к объектам

PATCH /objects/:id - Обновить объект частично

DELETE /objects/:id - Удалить объект

POST /objects/query - Выполнить запрос на объекты

GET /objects/:id/packets - Получить пакеты конкретного объекта

GET /objects/:id/logs/commands - Получить логи команд объекта

GET /objects/:id/model - Получить модель объекта

POST /objects/:id/task/changeid - Изменить ID задачи объекта

POST /objects/:id/task/cert - Управление сертификатами задачи

POST /objects/:id/task/clear - Очистить задачу

POST /objects/:id/task/delete - Удалить задачу

POST /objects/:id/task/fixState - Исправить состояние задачи

POST /objects/:id/task/copylinks - Скопировать ссылки задачи

POST /objects/:id/packets - Отправить пакет объекту

POST /objects/:id/model/autofill/start - Запустить автополнение модели

POST /objects/:id/model/autofill/stop - Остановить автополнение

POST /objects/:id/model/autofill/commit - Подтвердить автополнение

GET /objects/:id/model/autofill/state - Получить состояние автополнения

POST /objects/:id/commands/update_model - Обновить модель через команду

POST /objects/:id/commands/@service - Выполнить сервисную команду

POST /objects/:id/commands/@info - Получить информацию об объекте

POST /objects/:id/commands/@control - Управление объектом

POST /objects/:id/commands/@danger - Выполнить опасную команду

POST /objects/:id/commands/:command - Выполнить конкретную команду

GET /objects/stats - Получить статистику объектов

GET /objects/:id/stats - Получить статистику конкретного объекта

POST /objects/:id/bot/start - Запустить бота объекта

POST /objects/:id/bot/stop - Остановить бота

POST /objects/:id/bot/state - Получить состояние бота

POST /objects/:id/bot/config - Настроить бота

POST /objects/:id/bot/geo/start - Запустить гео-режим бота

POST /objects/:id/bot/geo/pause - Приостановить гео-режим

POST /objects/:id/bot/geo/stop - Остановить гео-режим

POST /objects/:id/bot/call - Вызвать бота

Логика (Автоматы)

GET /automatons/:id/statuses - Получить статусы автомата

GET /automatons/:id/start - Получить начальное состояние автомата

POST /automatons/:id/stop - Остановить автомат

GET /objects/:id/automatons/:automaton? - Получить автомат по параметрам

GET /objects/:id/automatons/:automaton/logs - Получить логи автомата

POST /objects/:id/automatons/:automaton/start - Запустить автомат

POST /objects/:id/automatons/:automaton/emmit - Выдать событие автомату

POST /objects/:id/automatons/:automaton/stop - Остановить автомат

POST /objects/:id/automatons/:automaton/run - Выполнить автомат

POST /automatons/parse_condition - Проверить условие автомата

POST /automatons/scheduler/get_next_invocation - Получить следующее время запуска

GET /automatons - Получить список автоматов

GET /automatons/:id - Получить автомат по ID

POST /automatons - Создать автомат

PATCH /automatons/:id - Обновить автомат частично

DELETE /automatons/:id - Удалить автомат

POST /automatons/access - Управление доступом к автоматам

DELETE /automatons/access - Удалить доступ

Обработчики

GET /handlers - Получить список обработчиков

GET /handlers/:id - Получить обработчик по ID

POST /handlers - Создать обработчик

PATCH /handlers/:id - Обновить обработчик

POST /handlers/access - Управление доступом

DELETE /handlers/access - Удалить доступ

POST /handlers/transpile - Компилировать обработчик

POST /handlers/bundle - Собрать бандл обработчика

POST /handlers/:id/exec - Выполнить обработчик

GET /handlers/:id/webhook - Получить webhook-конфиг

POST /handlers/:id/webhook - Установить webhook

DELETE /handlers/:id/webhook - Удалить webhook

GET /objects/:id/handlers - Получить обработчики объекта

POST /objects/:id/handlers/:handler/start - Запустить обработчик

POST /objects/:id/handlers/:handler/stop - Остановить обработчик

Действия

GET /actions - Получить список действий

GET /actions/:id - Получить действие по ID

DELETE /actions/:id - Удалить действие

POST /actions/access - Управление доступом

DELETE /actions/access - Удалить доступ

GET /actions/npm/:ns/:package - Получить действие из npm-пакета

GET /actions/npm/:package - Получить пакет действий

POST /actions - Создать действие

PATCH /actions/:id - Обновить действие

GET /actions/:id/status - Получить статус действия

GET /actions/:id/logs - Получить логи действия

POST /actions/:id/deploy - Развернуть действие

POST /actions/:id/exec - Выполнить действие

Геозоны

GET /geofences - Получить список геозон

GET /geofences/:id - Получить геозону по ID

POST /geofences - Создать геозону

PATCH /geofences/:id - Обновить геозону

DELETE /geofences/:id - Удалить геозону

POST /geofences/access - Управление доступом

DELETE /geofences/access - Удалить доступ

POST /objects/:id/geofences/:geofence/start - Запустить геозону на объекте

POST /objects/:id/geofences/:geofence/stop - Остановить геозону

Фигуры

GET /shapes - Получить список фигур

GET /shapes/:id - Получить фигуру по ID

POST /shapes - Создать фигуру

PATCH /shapes/:id - Обновить фигуру

DELETE /shapes/:id - Удалить фигуру

POST /shapes/access - Управление доступом

DELETE /shapes/access - Удалить доступ

GET /shapes/:id/file - Получить файл фигуры (например, изображение)

Метки

GET /labels - Получить список меток

GET /labels/:id - Получить метку по ID

POST /labels - Создать метку

PATCH /labels/:id - Обновить метку

DELETE /labels/:id - Удалить метку

POST /labels/access - Управление доступом

DELETE /labels/access - Удалить доступ

## Ретрансляторы

GET /repeaters/protocols - Получить протоколы ретрансляторов

GET /repeaters - Получить список ретрансляторов

GET /repeaters/:id - Получить ретранслятор по ID

POST /repeaters - Создать ретранслятор

PATCH /repeaters/:id - Обновить ретранслятор

DELETE /repeaters/:id - Удалить ретранслятор

POST /repeaters/access - Управление доступом

DELETE /repeaters/access - Удалить доступ

Дашборды

GET /dashboards - Получить список дашбордов

GET /dashboards/:id - Получить дашборд по ID

POST /dashboards - Создать новый дашборд

PATCH /dashboards/:id - Обновить дашборд частично

DELETE /dashboards/:id - Удалить дашборд

POST /dashboards/access - Управление доступом

DELETE /dashboards/access - Удалить доступ

Отчеты

GET /reports - Получить список отчетов

GET /reports/:id - Получить отчет по ID

POST /reports - Создать отчет

PATCH /reports/:id - Обновить отчет

DELETE /reports/:id - Удалить отчет

POST /reports/access - Управление доступом

DELETE /reports/access - Удалить доступ

GET /reports/:id/export - Экспорт отчета

POST /reports/:id/build - Запустить генерацию отчета

PATCH /reports/:id/layout - Изменить макет отчета

GET /reports/:id/jobs - Получить задания для отчета

POST /reports/:id/jobs - Создать задание для отчета

PATCH /reports/:id/jobs/:jobId - Обновить задание

DELETE /reports/:id/jobs/:jobId - Удалить задание

Задания

GET /tasks/mine - Получить свои задачи

POST /tasks - Создать новую задачу

POST /tasks/archive/clear - Очистить архив задач

GET /tasks - Получить список задач

GET /tasks/:id - Получить задачу по ID

PATCH /tasks/:id - Обновить задачу

DELETE /tasks/:id - Удалить задачу

POST /tasks/access - Управление доступом

DELETE /tasks/access - Удалить доступ

GET /tasks/kinds - Получить типы задач

GET /tasks/kinds/:id - Получить тип задачи по ID

POST /tasks/kinds - Создать тип задачи

PATCH /tasks/kinds/:id - Обновить тип задачи

DELETE /tasks/kinds/:id - Удалить тип задачи

POST /tasks/kinds/access - Управление доступом к типам задач

DELETE /tasks/kinds/access - Удалить доступ

## Таблицы

GET /tables - Получить список таблиц

GET /tables/:id - Получить таблицу по ID

POST /tables - Создать таблицу

PATCH /tables/:id - Обновить таблицу

DELETE /tables/:id - Удалить таблицу

POST /tables/access - Управление доступом

DELETE /tables/access - Удалить доступ

GET /tables/:ns/:table - Получить таблицу из пространства имён

GET /tables/:ns/:table/:id - Получить запись в таблице

POST /tables/:ns/:table - Добавить запись в таблицу

PATCH /tables/:ns/:table/:id - Обновить запись

DELETE /tables/:ns/:table/:id - Удалить запись

События

GET /events - Получить список событий

POST /events - Создать событие

GET /groups/:id/events - Получить события группы

GET /objects/:id/events - Получить события объекта

POST /objects/:id/events - Отправить событие объекту

## Настройки проекта

GET /admin/boot - Получить конфигурацию старта системы

Клиенты

POST /clients/:id/sms - Отправить SMS клиенту

POST /clients/:id/push - Отправить push-уведомление

GET /clients - Получить список клиентов

GET /clients/:id - Получить клиента по ID

POST /clients - Создать клиента

PATCH /clients/:id - Обновить клиента

DELETE /clients/:id - Удалить клиента

POST /clients/access - Управление доступом

DELETE /clients/access - Удалить доступ

Инструменты

GET /logs/:type - Получить логи по типу

GET /tools - Получить список инструментов

GET /tools/:id - Получить инструмент по ID

POST /tools - Создать инструмент

PATCH /tools/:id - Обновить инструмент

## Иконки

GET /icons - Получить список иконок

POST /icons - Создать иконку

PATCH /icons/:id - Обновить иконку

DELETE /icons/:id - Удалить иконку

POST /icons/access - Управление доступом

DELETE /icons/access - Удалить доступ

Связи

POST /links/labels/to/objects - Связать метку с объектом

POST /links/automatons/to/objects - Связать автомат с объектом

POST /links/geofences/to/objects - Связать геозону с объектом

POST /links/handlers/to/objects - Связать обработчик с объектом

POST /links/actions/to/objects - Связать действие с объектом

POST /links/repeaters/to/objects - Связать ретранслятор с объектом

POST /links/skills/to/objects - Связать навык с объектом

POST /links/dashboards/to/objects - Связать дашборд с объектом

Сообщения

GET /messages - Получить список сообщений

POST /messages - Создать сообщение

PATCH /messages/read/:id - Отметить сообщение как прочитанное

DELETE /messages/clear - Очистить все сообщения

GET /messages/history - Получить историю сообщений

GET /messages/history/bounds - Получить границы истории сообщений

Уведомления

GET /notifiers - Получить список уведомлений

GET /notifiers/:id - Получить уведомление по ID

POST /notifiers - Создать уведомление

PATCH /notifiers/:id - Обновить уведомление

DELETE /notifiers/:id - Удалить уведомление

POST /notifiers/access - Управление доступом

DELETE /notifiers/access - Удалить доступ

Аренда

GET /tariffs - Получить список тарифов

PATCH /tariffs/:id - Обновить тариф

POST /tariffs/access - Управление доступом к тарифам

GET /rates - Получить список ставок

GET /rates/:id - Получить ставку по ID

PATCH /objects/:id/status - Обновить статус объекта

PATCH /objects/:id/rental/status - Обновить статус аренды

POST /objects/:id/rental/check - Проверить возможность аренды

GET /objects/:id/rent - Получить информацию об аренде

PATCH /clients/:id/tariff - Назначить тариф клиенту

PATCH /clients/:id/status - Обновить статус клиента

POST /clients/:id/invoices - Создать счёт для клиента

GET /invoices/:id? - Получить счёт по ID

POST /invoices/:id/close - Закрыть счёт

POST /invoices/:id/revoke - Отозвать счёт

POST /invoices/:id/received - Отметить счёт как оплаченный

POST /invoices/:id/billing - Выставить биллинг

Пользователи

GET /users/help/config - Получить конфигурацию помощи

GET /users - Получить список пользователей

GET /users/:id - Получить пользователя по ID

POST /users - Создать пользователя

PATCH /users/:id - Обновить пользователя

DELETE /users/:id - Удалить пользователя

POST /users/access - Управление доступом

DELETE /users/access - Удалить доступ

POST /users/filters - Создать фильтр для пользователя

PATCH /users/filters/:id - Обновить фильтр

DELETE /users/filters/:id - Удалить фильтр

POST /users/filters/access - Управление доступом к фильтрам

DELETE /users/filters/access - Удалить доступ

GET /users/filters - Получить список фильтров пользователя

Прочее (UI-компоненты)

UI Admin project - Конфигурация административного проекта

UI Users web projects - Проекты пользователей в веб-интерфейсе

UI Config config - Общая конфигурация системы

UI Console legacy data web - Устаревшие данные консоли для веба

UI Console legacy i18n web - Локализация устаревшей консоли

UI Links links - Настройки ссылок в интерфейсе

UI Objects view map - Настройки отображения объектов на карте

UI Objects view table - Настройки отображения объектов в таблице

UI Objects labelposition - Позиционирование меток объектов

UI Objects labelindicators - Индикаторы меток объектов

UI Objects model autofill - Автополнение моделей объектов

UI Analytics grafana - Интеграция с Grafana (аналитика)

UI Geofences beacons - Настройки ближайших точек (beacons) геозон

UI Geofences floors - Уровни (этажи) в геозонах

UI Logic v2 logic - Логика версии 2

UI Logic v2 view code - Отображение кода логики v2

UI Console legacy models web - Устаревшие модели в консоли

UI Models web models web - Веб-модели

UI Models v3 models - Модели версии 3

UI Models v3 editor - Редактор моделей v3

UI Models v3 actionlevels - Уровни действий в моделях v3

UI Models v3 tags - Теги моделей v3

Группы

GET /groups/:id/members - Получить членов группы

POST /groups - Создать новую группу

DELETE /groups/:id - Удалить группу

GET /groups/:id/users - Получить пользователей в группе

PATCH /groups/:id/filters - Обновить фильтры группы

POST /groups/access - Управление доступом к группам

DELETE /groups/access - Удалить доступ

GET /groups - Получить список групп

GET /groups/:id - Получить группу по ID

PATCH /groups/:id - Обновить группу частично

Роли

GET /roles - Получить список ролей

GET /roles/:id - Получить роль по ID

POST /roles - Создать новую роль

PATCH /roles/:id - Обновить роль

POST /roles/access - Управление доступом к ролям

DELETE /roles/access - Удалить доступ

## API Токены

GET /tokens - Получить список токенов

POST /tokens - Создать новый API-токен

География

GET /geo/direct - Прямое геокодирование (адрес → координаты)

GET /geo/reverse - Обратное геокодирование (координаты → адрес)

GET /geo/route - Получить маршрут между точками

GET /geo/osrm - Использование OSRM (Open Source Routing Machine) для маршрутизации

## Секреты

GET /secrets - Получить список секретов

GET /secrets/:id - Получить секрет по ID

## Консоль

GET /console/boot - Получить конфигурацию запуска консоли

POST /console/parents - Установить родительскую консоль

PATCH /console/parents/:id - Обновить родительскую консоль

## Домены

GET /domains - Получить список доменов

GET /domains/:id - Получить домен по ID

POST /domains - Создать домен

PATCH /domains/:id - Обновить домен

DELETE /domains/:id - Удалить домен

POST /domains/access - Управление доступом

DELETE /domains/access - Удалить доступ

SMPP (SMS)

POST /smpp/check/:id? - Проверить соединение SMPP-сервера

POST /smpp/send - Отправить SMS через SMPP

## SMTP (Email)

POST /smtp/check/:id - Проверить SMTP-сервер

POST /smtp/send - Отправить email через SMTP

Тексты (Шаблоны)

GET /texts - Получить список текстовых шаблонов

GET /texts/:id - Получить шаблон по ID

POST /texts - Создать текстовый шаблон

PATCH /texts/:id - Обновить шаблон

POST /texts/access - Управление доступом

DELETE /texts/access - Удалить доступ

Файлы

GET /files - Получить список файлов

GET /files/:id - Получить файл по ID

GET /files/public/:id - Получить публичный файл

POST /files - Загрузить файл

DELETE /files/:id - Удалить файл

Grafana (Аналитика)

GET /grafana - Получить общую информацию о Grafana

GET /grafana/dashboards - Получить дашборды Grafana

GET /grafana/search - Поиск в Grafana

POST /grafana/query - Выполнить запрос к Grafana (например, получить данные графиков)