5.8. REST API
Универсальный REST API предоставляет следующую функциональность:
-
CRUD операции над сущностями.
-
Выполнение предопределенных JPQL запросов.
-
Вызов методов сервисов.
-
Получение метаданных (сущности, представления, перечисления, типы данных).
-
Получение разрешений для текущего пользователя (доступ к сущностям, атрибутам, специфические разрешения).
-
Получение информации о текущем пользователе (имя, язык, временная зона и т.д.).
-
Загрузка и скачивание файлов.
REST API использует протокол OAuth2 для аутентификации и поддерживает анонимный доступ.
Подробная документация по REST API доступна по следующему адресу: http://files.cuba-platform.com/swagger/6.10.
Раздел Использование REST API сборника рецептов содержит большое количество примеров, демонстрирующих возможности REST API в действии. В разделах ниже приведено формальное описание некоторых особенностей и конфигурационных параметров.