Принципы работы с REST API¶

Общая информация¶

REST API повторяет функциональность, доступную в пользовательском интерфейсе.

Сначала в системах Юниверс MDM и DG необходимо создать модель данных, состоящую из нескольких частей. Получить примеры описаний моделей можно, создав тестовые варианты в интерфейсе пользователя и экспортировав их. Состав модели данных:
- Модель данных (основная часть, содержит описание реестров и справочников).
- Источники данных.
- Единицы измерения.
- Перечисления.
- Модель качества данных.
- Модель сопоставления.
- Модель бизнес-процесса (только для Enterprise Edition).
Запросы работы с моделями данных размещаются в сервисах universe-backend/api/v2/meta и universe-backend/api/v2/data.
Многие запросы к данным в последствии будут опираться на структуру модели данных, модели качества данных и т.д. Например, при создании записи заполнять атрибуты согласно модели данных и учитывать свойства атрибутов, указанных в модели.

Примечание

Файл model.xml (модель данных) должен импортироваться после файлов перечислений и единиц измерения, но до файлов модели качества данных и модели сопоставления

Важные изменения¶

В релизе 6.9 запросы REST API v1 отмечены как устаревшие, поэтому они были исключены из сборки и перешли на v2:

Исключены из SE/EE:

org.unidata.mdm.rest.core

org.unidata.mdm.rest.v1.search

org.unidata.mdm.rest.v1.meta

org.unidata.mdm.rest.v1.data

org.unidata.mdm.rest.v1.draft

org.unidata.mdm.rest.v1.dq.core

org.unidata.mdm.rest.v1.dq.data

org.unidata.mdm.rest.v1.bulk.core

org.unidata.mdm.rest.v1.matching.core

org.unidata.mdm.rest.v1.matching.data

com.unidata.mdm.rest.v1.bulk.remove.records

com.unidata.mdm.rest.v1.workflow.core

Исключены из CE:

org.unidata.mdm.rest.core

org.unidata.mdm.rest.v1.data

org.unidata.mdm.rest.v1.meta

org.unidata.mdm.rest.v1.draft

org.unidata.mdm.rest.v1.search

org.unidata.mdm.rest.v1.dq.core

org.unidata.mdm.rest.v1.dq.data

org.unidata.mdm.rest.v1.matching.core

org.unidata.mdm.rest.v1.matching.data

org.unidata.mdm.rest.v1.bulk.core

Изменения в org.unidata.mdm.rest.system.ro.RightRO¶

В версии 6.8 в результате переработки логики работы системы безопасности изменилась и работа некоторых запросов REST API.

Из REST API удалены эндпоинты: DELETE /security/role/unlink/{roleName}/{resourceName} и GET /security/role/get-all-secured-resources.

В org.unidata.mdm.rest.system.ro.RightRO упростилась структура запроса. Было:

{
"createdAt": "<dateTime>",
"updatedAt": "<dateTime>",
"createdBy": "<string>",
"updatedBy": "<string>",
"securedResource": {
    "name": "<string>",
    "displayName": "<string>",
    "type": "<string>",
    "category": "<string>"
},
"create": "<boolean>",
"update": "<boolean>",
"delete": "<boolean>",
"read": "<boolean>"
}

Стало:

{
"securedResource": {
    "id":"<string>"
},
"rights": ["string"],
}