Entity - Get Classification

服務:

Purview

API 版本:

2023-09-01

取得 GUID 所表示之指定實體的分類。

GET {endpoint}/datamap/api/atlas/v2/entity/guid/{guid}/classification/{classificationName}

URI 參數

名稱	位於	必要	類型	Description
classificationName	path	True	string	分類的名稱。
endpoint	path	True	string
guid	path	True	string	實體的全域唯一標識碼。

回應

名稱	類型	Description
200 OK	AtlasClassification	要求已成功。
Other Status Codes	AtlasErrorResponse	未預期的錯誤回應。

安全性

OAuth2Auth

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

範圍

名稱	Description
https://purview.azure.net/.default

範例

Entity_GetClassification

範例要求

HTTP

GET {endpoint}/datamap/api/atlas/v2/entity/guid/9347abc5-7b86-4b82-a1e2-ad77c7c3cac3/classification/MICROSOFT.PERSONAL.DATE_OF_BIRTH

範例回覆

狀態碼:

200

{
  "typeName": "MICROSOFT.PERSONAL.DATE_OF_BIRTH",
  "lastModifiedTS": "1",
  "entityGuid": "9347abc5-7b86-4b82-a1e2-ad77c7c3cac3",
  "entityStatus": "ACTIVE"
}

定義

名稱	Description
AtlasClassification	分類的實例;它沒有身分識別，只有與實體相關聯的物件存在。
AtlasErrorResponse	來自服務的錯誤回應
EntityStatus	狀態 - 可以是作用中或刪除
TimeBoundary	擷取時間界限詳細數據

AtlasClassification

分類的實例;它沒有身分識別，只有與實體相關聯的物件存在。

名稱	類型	Description
attributes		結構的屬性。
entityGuid	string	實體的 GUID。
entityStatus	EntityStatus	實體的狀態 - 可以是作用中或刪除。 不會移除已刪除的實體。
lastModifiedTS	string	並行控制的 ETag。
removePropagationsOnEntityDelete	boolean	判斷是否會在實體刪除時移除傳播。
typeName	string	型別的名稱。
validityPeriods	TimeBoundary[]	指出有效期間的時間界限陣列。

AtlasErrorResponse

來自服務的錯誤回應

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

EntityStatus

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

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

TimeBoundary

擷取時間界限詳細數據

名稱	類型	Description
endTime	string	時間界限的結尾。
startTime	string	時間界限的開始。
timeZone	string	時間界限的時區。