Glossary - Assign Term To Entities

參考

服務:: Purview

API 版本:: 2023-09-01

將指定字詞指派給提供的相關物件清單。建議搭配多個 API 呼叫使用小型批次。

實體建立或更新作業是將字詞指派給多個實體的替代方案。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string
termId	path	True	string	詞彙的全域唯一標識碼。

要求本文

名稱	類型	Description
body	AtlasRelatedObjectId[]	相關物件標識碼的陣列，該字詞必須與其相關聯。

回應

名稱	類型	Description
204 No Content		此要求沒有要傳送的內容，但標頭可能很有用。
Other Status Codes	AtlasErrorResponse	非預期的錯誤回應。

安全性

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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

定義

名稱	Description
AtlasErrorResponse	來自服務的錯誤回應
AtlasRelatedObjectId	在關聯屬性值中使用的 AtlasEntity 型別對象實例參考
AtlasStruct	擷取結構內容的詳細數據。未直接具現化，僅透過 AtlasEntity、AtlasClassification 使用。
EntityStatus	狀態 - 可以是作用中或刪除
StatusAtlasRelationship	atlas 關聯性的狀態

AtlasErrorResponse

來自服務的錯誤回應

名稱	類型	Description
errorCode	string	錯誤碼。
errorMessage	string	錯誤訊息。
requestId	string	要求識別碼。

AtlasRelatedObjectId

在關聯屬性值中使用的 AtlasEntity 型別對象實例參考

名稱	類型	Description
displayText	string	顯示文字。
entityStatus	EntityStatus	實體的狀態 - 可以是作用中或刪除。已刪除的實體不會移除。
guid	string	物件的 GUID。
relationshipAttributes	AtlasStruct	擷取結構內容的詳細數據。未直接具現化，僅透過 AtlasEntity、AtlasClassification 使用。
relationshipGuid	string	關聯性的 GUID。
relationshipStatus	StatusAtlasRelationship	關聯性狀態的列舉。
relationshipType	string	關聯性類型
typeName	string	型別的名稱。
uniqueAttributes		物件的唯一屬性。

AtlasStruct

擷取結構內容的詳細數據。未直接具現化，僅透過 AtlasEntity、AtlasClassification 使用。

名稱	類型	Description
attributes		結構的屬性。
lastModifiedTS	string	ETag 用於並行控制。
typeName	string	型別的名稱。

EntityStatus

狀態 - 可以是作用中或刪除

名稱	類型	Description
ACTIVE	string	狀態為作用中。
DELETED	string	狀態已刪除。

StatusAtlasRelationship

atlas 關聯性的狀態

名稱	類型	Description
ACTIVE	string	作用中
DELETED	string	已刪除

共用方式為