Records API
Records API — интерфейс на уровне системы для доступа и манипуляции данными. Данными являются записи.
Запись (Record) — сущность с набором атрибутов и идентификатором записи (RecordRef).
Данные можно получить, используя браузер или бэкенд (kotlin/java) — подробнее в темах раздела ниже.
Общее описание
API, разработанное для организации простого и легко масштабируемого общения между потребителем информации и источником. Источниками данных могут быть БД, REST и др.
Преимущества:
Единый API для доступа к данным в системе для всех потребителей (Браузер, Мобильное приложение, Система построения отчетов, Индексирование данных, Различные микросервисы и т.д.);
Поддержка загрузки данных из связанных сущностей. Например, по ссылке из договора можно запросить поддерживаемые атрибуты доверенности с учётом прав доступа;
Потребитель задаёт состав результата. Фактический объём загрузки и вычислений зависит от реализации источника и зависимостей запрошенных атрибутов;
Разработчик источника предоставляет данные и обработку поддерживаемых атрибутов. Потребитель указывает в запросе нужные атрибуты;
Добавление новых атрибутов позволяет расширять модель без изменения запросов существующих потребителей при сохранении прежнего контракта атрибутов. REST-контракт имеет версии;
Схема запроса, скаляры и DTO определяют представление результата в пределах поддерживаемых преобразований типов;
Вычисляемые атрибуты. Возможность добавлять атрибуты, которые не хранятся в БД или любом другом хранилище, а вычисляются на основе существующих;
Поддержка объединения атрибутов из разных источников. Например, можно написать источник данных, который часть атрибутов будет брать из alfresco, а часть из внешней БД объединяя их по идентификатору.
Основные операции: поиск записей, получение атрибутов, создание или изменение записей и удаление. Поддержка конкретных операций определяется источником данных.
Раздел включает следующие темы:
Ключевые термины и принцип работы Records API.
Синтаксис запроса атрибутов записи: значения, ассоциации, модификаторы.
Сервис для поиска, получения, изменения и удаления записей.
Формат идентификатора записи и работа со ссылками между сущностями.
Работа с Records API через глобальный компонент Records и CRUD-операции.
Работа с Records API на бэкенде через библиотеку ecos-records.
Полная грамматика синтаксиса атрибутов Citeck Records.
Готовые примеры запросов и операций.