API
Реестры
Реестры
Реестры — структурированные каталоги бизнес-данных (договоры, контрагенты, лицензии и т.п.).
Реестры — каталог полей
Каталог полей реестров (типы, единицы, форматы).
Реестры — папки
Папки реестров — группировка реестров в иерархию.
Реестры — источники данных
Внешние источники данных для реестров (файлы, Google Sheets, Dropbox).
Операции
Всего операций: 32. Полные схемы запросов и ответов — на страницах разделов.
Реестры
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/registry/calendar-dates | Календарь дат с записями |
POST | /api/v1/registry/reindex | Переиндексация всех записей |
GET | /api/v1/registry/types | Список реестров |
POST | /api/v1/registry/types | Создать реестр |
DELETE | /api/v1/registry/types/{typeId} | Удалить реестр |
GET | /api/v1/registry/types/{typeId} | Получить реестр |
PATCH | /api/v1/registry/types/{typeId} | Обновить реестр |
GET | /api/v1/registry/{typeId}/export | Экспорт записей реестра в XLSX |
GET | /api/v1/registry/{typeId}/records | Список записей |
POST | /api/v1/registry/{typeId}/records | Создать запись реестра |
DELETE | /api/v1/registry/{typeId}/records/{recordId} | Удалить запись реестра |
GET | /api/v1/registry/{typeId}/records/{recordId} | Получить запись |
PATCH | /api/v1/registry/{typeId}/records/{recordId} | Обновить запись реестра |
POST | /api/v1/registry/{typeId}/search | Поиск записей реестра |
POST | /api/v1/registry/{typeId}/sync | Массовая синхронизация записей реестра |
Реестры — каталог полей
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/registry/catalog | Каталог полей реестров |
POST | /api/v1/registry/catalog/suggest | Подсказать поля каталога по колонкам |
Реестры — папки
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/registry/folders | Список папок реестров (с фильтрацией по доступу) |
POST | /api/v1/registry/folders | Создать папку реестров |
DELETE | /api/v1/registry/folders/{folderId} | Удалить папку реестров |
PATCH | /api/v1/registry/folders/{folderId} | Обновить папку реестров |
POST | /api/v1/registry/folders/{folderId}/move-type | Переместить реестр в папку |
DELETE | /api/v1/registry/folders/{folderId}/shares | Отозвать доступ к папке |
POST | /api/v1/registry/folders/{folderId}/shares | Поделиться папкой |
GET | /api/v1/registry/folders/{folderId}/types | Реестры в папке |
Реестры — источники данных
| Метод | Путь | Операция |
|---|---|---|
DELETE | /api/v1/registry/sources/{sourceId} | Удалить источник данных |
GET | /api/v1/registry/sources/{sourceId} | Получить источник данных |
PUT | /api/v1/registry/sources/{sourceId} | Обновить источник данных |
PATCH | /api/v1/registry/sources/{sourceId}/sync | Отметить источник как синхронизированный |
POST | /api/v1/registry/sources/{sourceId}/sync | Синхронизировать источник |
GET | /api/v1/registry/types/{typeId}/sources | Список источников данных реестра |
POST | /api/v1/registry/types/{typeId}/sources | Создать источник данных для реестра |