Реестры
REST API раздела «Реестры»: 38 операций.
Базовый адрес: https://api.legalstack.ru. Спецификация: openapi/registry.json.
Реестры и записи
Реестры — структурированные каталоги бизнес-данных (договоры, контрагенты, лицензии и т.п.).
Каталог полей
Каталог полей реестров (типы, единицы, форматы).
Папки
Папки реестров — группировка реестров в иерархию.
Источники данных
Внешние источники данных для реестров (файлы, Google Sheets, Dropbox).
Операции
Всего операций: 38. У каждой операции своя страница со схемами запроса и ответа и примерами вызова.
Реестры и записи
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/registry/calendar-dates | Календарь дат с записями |
GET | /api/v1/registry/lookup | Поиск записей во всех доступных реестрах |
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} | Обновить реестр |
PUT | /api/v1/registry/{typeId}/agent-edit-mode | Переключить режим правок агента для реестра |
GET | /api/v1/registry/{typeId}/export | Экспорт всех записей реестра в XLSX или JSON |
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 | Поиск записей реестра |
GET | /api/v1/registry/{typeId}/suggestions | Нерассмотренные предложения агента по записям реестра |
POST | /api/v1/registry/{typeId}/suggestions/resolve-all | Принять или отклонить все предложения агента по реестру |
POST | /api/v1/registry/{typeId}/suggestions/{suggestionId}/accept | Принять предложение агента |
POST | /api/v1/registry/{typeId}/suggestions/{suggestionId}/reject | Отклонить предложение агента |
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 | Создать источник данных для реестра |