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[]	用語を関連付ける必要がある関連オブジェクト ID の配列。

応答

名前	型	説明
204 No Content		この要求に送信するコンテンツはありませんが、ヘッダーが役立つ場合があります。
Other Status Codes	AtlasErrorResponse	予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 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	要求 ID です。

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

次の方法で共有