Glossary - Assign Term To Entities

Ссылка

Служба:: Purview

Версия API:: 2023-09-01

Назначьте заданный термин указанному списку связанных объектов. Рекомендуется использовать небольшие пакеты с несколькими вызовами API.

Операция создания или обновления сущностей — это альтернатива назначению термина нескольким сущностям.

POST {endpoint}/datamap/api/atlas/v2/glossary/terms/{termId}/assignedEntities

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string
termId	path	True	string	Глобальный уникальный идентификатор термина глоссария.

Текст запроса

Имя	Тип	Описание
body	AtlasRelatedObjectId[]	Массив связанных идентификаторов объектов, с которыми должен быть связан термин.

Ответы

Имя	Тип	Описание
204 No Content		Содержимое для этого запроса не отправляется, но заголовки могут оказаться полезными.
Other Status Codes	AtlasErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://purview.azure.net/.default

Примеры

Glossary_AssignTermToEntities

Образец запроса

HTTP

POST {endpoint}/datamap/api/atlas/v2/glossary/terms/8a7f65ec-6429-0b9b-3734-ec57bf1e34c2/assignedEntities

[
  {
    "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0",
    "relationshipAttributes": {
      "attributes": {
        "expression": "Example Expression",
        "confidence": 100,
        "description": "Example Description",
        "source": "ExampleSource"
      }
    }
  }
]

Пример ответа

Код состояния:: 204

Определения

Имя	Описание
AtlasErrorResponse	Ответ об ошибке от службы
AtlasRelatedObjectId	Ссылка на экземпляр объекта типа AtlasEntity, используемого в значениях атрибута связи
AtlasStruct	Записывает сведения о содержимом структуры. Не создается напрямую, используется только через AtlasEntity, AtlasClassification.
EntityStatus	Состояние — может быть активным или удаленным.
StatusAtlasRelationship	Состояние связи atlas

AtlasErrorResponse

Ответ об ошибке от службы

Имя	Тип	Описание
errorCode	string	Код ошибки.
errorMessage	string	Сообщение об ошибке.
requestId	string	Идентификатор запроса.

AtlasRelatedObjectId

Ссылка на экземпляр объекта типа AtlasEntity, используемого в значениях атрибута связи

Имя	Тип	Описание
displayText	string	Отображаемый текст.
entityStatus	EntityStatus	Состояние сущности — может быть активным или удаленным. Удаленные сущности не удаляются.
guid	string	Идентификатор GUID объекта .
relationshipAttributes	AtlasStruct	Записывает сведения о содержимом структуры. Не создается напрямую, используется только через AtlasEntity, AtlasClassification.
relationshipGuid	string	GUID связи.
relationshipStatus	StatusAtlasRelationship	Перечисление состояния связи.
relationshipType	string	Тип отношений
typeName	string	Имя типа.
uniqueAttributes		Уникальные атрибуты объекта .

AtlasStruct

Записывает сведения о содержимом структуры. Не создается напрямую, используется только через AtlasEntity, AtlasClassification.

Имя	Тип	Описание
attributes		Атрибуты структуры.
lastModifiedTS	string	ETag для управления параллелизмом.
typeName	string	Имя типа.

EntityStatus

Состояние — может быть активным или удаленным.

Имя	Тип	Описание
ACTIVE	string	Состояние активно.
DELETED	string	Состояние удалено.

StatusAtlasRelationship

Состояние связи atlas

Имя	Тип	Описание
ACTIVE	string	active
DELETED	string	deleted

Поделиться через