Налаштування атрибутів доступу до API-представлень реєстру

Загальний опис

Окрім надання доступу до реєстру для інших реєстрів або зовнішніх систем в адміністративній панелі Control Plane (див. Налаштування доступу до реєстрів), адміністратор реєстру має відкрити доступ до представлень (view) та REST API-ендпоінтів, які згенеровані на базі цих представлень, на рівні моделі даних.

Налаштування доступу до REST API представлень (view) реєстру відбувається за допомогою спеціальних атрибутів доступу на рівні моделі даних Liquibase. Це дозволяє відкрити доступ до API реєстру, що створюються із відповідних представлень, іншим реєстрам на Платформі або зовнішнім системам.

Для цього використовується спеціальний тег <exposeSearchCondition>.

Опис тегу <exposeSearchCondition> ви можете також переглянути на сторінці Перелік розширених тегів Liquibase.

Тег <exposeSearchCondition> приймає 1 атрибут для назви критерію пошуку (search condition), а також 3 атрибути для різних сценаріїв використання:

  • Надання доступу до представлень та REST API реєстру для іншого реєстру на Платформі — для цього використовується атрибут platform.

  • Надання доступу до представлень та REST API реєстру для зовнішньої системи — для цього використовується атрибут externalSystem.

  • Надання доступу до представлень реєстру для сервісів-учасників СЕВ ДЕІР через інтерфейс ШБО "Трембіта" за протоколом SOAP — для цього використовується атрибут trembita.

Приклад 1. Приклад XML-схеми використання тегу та його атрибутів у моделі даних
<ext:exposeSearchCondition name="viewForDrop" platform="true" externalSystem="true" trembita="false"/>

  • name — назва представлення для критерію пошуку (search condition)

  • platform — для надання доступу має бути у значенні "true"

  • externalSystem — для надання доступу має бути у значенні "true".

  • trembita — для надання доступу має бути у значенні "true"

Якщо необхідно закрити доступ до представлень API реєстру, то відповідні атрибути мають бути у значенні false.

Поточний приклад конфігурації показує, що доступ до даних реєстру може бути відкритий для іншого реєстру на Платформі, а також для зовнішньої системи. Для сервісів, що отримуватимуть дані через SOAP-інтерфейс ШБО "Трембіта", доступ до даних є закритим.