Описание: Общее описание REST API портала. API организовано по функциональным группам методов; каждая группа — отдельная подстраница с индексом входящих в неё методов.
🔑 Получение токена авторизации
Прежде чем вызывать любой другой метод API, необходимо получить токен сессии пользователя, вызвав метод Получить токен авторизации (Login). Полученный токен передаётся в заголовке Authorization при всех последующих вызовах REST API.
📚 Индекс разделов
| Раздел | Описание |
|---|---|
| Авторизация | Получение токена, вход по логину/паролю, NTLM, OpenID Connect, двухфакторная аутентификация, сессия, выход |
| Пароли и восстановление доступа | Установка/смена пароля, восстановление по e-mail, TOTP |
| Права доступа | Настройка уникальных прав на элемент, получение списка прав |
| Элементы и связи | CRUD по элементам, ссылки, lookup-поиск |
| Списки | Работа со списками и действиями над списками |
| Файлы и документы | Загрузка/скачивание файлов, версии, подписание, публичные ссылки |
| Представления | Представления и части представлений |
| Типы контента | Типы контента |
| Конфигурация | Чтение системных настроек портала |
| Лицензии | Статус лицензирования портала |
| Экспорт | Экспорт данных |
| Корзина | Удалённые элементы, восстановление, фоновая очистка |
| Процессы | Маршруты согласования, задачи процессов (Workflows) |
| Автоматизация | Мост между рабочими процессами (Elsa) и порталом: произвольный POST, дублирование типа контента, импорт файла, условия/действия автоматизации |
| Синхронизация атрибутов | Отдельный модуль для Vitro-клиента: синхронизация атрибутов в штампы чертежа |
| Оповещения | Отправка почтовых оповещений по шаблону |
| Штампы и печати | Штампы, QR-коды, объединение PDF, экспорт/импорт замечаний |
| Импорт | Импорт данных из Excel |
| Отчёты | Формирование отчётов |
| Просмотр BIM-моделей | Модели, сцены, элементы моделей, 3D-текст |
| Просмотр CAD-моделей | Получение конвертированных CAD-моделей и превью |
| Редактор OnlyOffice | Интеграция с OnlyOffice |
| Табели рабочего времени | Timesheets |
| Активность | Лента активности по элементу |
| Замечания (Issues) | Работа с замечаниями |
| Вычисления | Расчётные операции с формулами |