Entity - Get

參考

服務:: Purview

API 版本:: 2023-09-01

取得實體的完整定義，指定其 GUID。

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

含選擇性參數:

GET {endpoint}/datamap/api/atlas/v2/entity/guid/{guid}?minExtInfo={minExtInfo}&ignoreRelationships={ignoreRelationships}

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string
guid	path	True	string	實體的全域唯一標識碼。
ignoreRelationships	query		boolean	是否要忽略關聯性屬性。
minExtInfo	query		boolean	是否要傳回參考實體的最低資訊。

回應

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

安全性

OAuth2Auth

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

範圍

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

範例

Entity_Get

範例要求

HTTP

GET {endpoint}/datamap/api/atlas/v2/entity/guid/5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb?minExtInfo=True

範例回覆

狀態碼:: 200

{
  "referredEntities": {},
  "entity": {
    "typeName": "column",
    "attributes": {
      "owner": null,
      "qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/Target/XmlPeek/@XmlInputPath",
      "name": "~XmlInputPath",
      "description": null,
      "type": "string"
    },
    "guid": "5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb",
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "createTime": 1553072455110,
    "updateTime": 1553072455110,
    "version": 0,
    "relationshipAttributes": {
      "schema": [],
      "inputToProcesses": [],
      "composeSchema": {
        "guid": "cc6652ae-dc6d-90c9-1899-252eabc0e929",
        "typeName": "tabular_schema",
        "displayText": "tabular_schema",
        "relationshipGuid": "5a4510d4-57d0-467c-888f-4b61df42702b",
        "relationshipStatus": "ACTIVE",
        "relationshipAttributes": {
          "typeName": "tabular_schema_columns"
        }
      },
      "meanings": [],
      "outputFromProcesses": [],
      "tabular_schema": null
    },
    "contacts": {
      "Expert": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
          "info": "Example Expert Info"
        }
      ],
      "Owner": [
        {
          "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
          "info": "Example Owner Info"
        }
      ]
    }
  }
}

定義

名稱	Description
AtlasClassification	分類的實例;它沒有身分識別，此物件只有在與實體相關聯時才存在。
AtlasEntity	實體的實例，例如hive_table，hive_database。
AtlasEntityWithExtInfo	實體的實例以及擴充資訊，例如hive_table，hive_database。
AtlasErrorResponse	來自服務的錯誤回應
AtlasTermAssignmentHeader	字詞指派的標頭。
AtlasTermAssignmentStatus	字詞指派的狀態
EntityStatus	狀態 - 可以是作用中或刪除
TimeBoundary	擷取時間界限詳細數據

AtlasClassification

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

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

AtlasEntity

實體的實例，例如hive_table，hive_database。

名稱	類型	Description
attributes		結構的屬性。
businessAttributes		商務屬性
classifications	AtlasClassification[]	分類的陣列。
collectionId	string	實體的集合標識碼。
contacts	object	實體聯繫人的字典。索引鍵可以是專家或擁有者。
createTime	integer	記錄的建立時間。
createdBy	string	建立記錄的使用者。
customAttributes	object	自訂屬性
guid	string	實體的 GUID。
homeId	string	實體的主標識碼。
isIncomplete	boolean	它是否為殼層實體
labels	string[]	標籤
lastModifiedTS	string	ETag 用於並行控制。
meanings	AtlasTermAssignmentHeader[]	詞彙指派標頭的陣列，指出實體的意義。
provenanceType	integer	用來記錄實體或關聯性實例的證明。
proxy	boolean	判斷是否有 Proxy。
relationshipAttributes		關聯性的屬性。
status	EntityStatus	實體的狀態 - 可以是作用中或刪除。已刪除的實體不會移除。
typeName	string	型別的名稱。
updateTime	integer	記錄的更新時間。
updatedBy	string	更新記錄的使用者。
version	integer	實體的版本。

AtlasEntityWithExtInfo

實體的實例以及擴充資訊，例如hive_table，hive_database。

名稱	類型	Description
entity	AtlasEntity	實體的實例，例如hive_table，hive_database。
referredEntities	<string, AtlasEntity>	參考的實體。

AtlasErrorResponse

來自服務的錯誤回應

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

AtlasTermAssignmentHeader

字詞指派的標頭。

名稱	類型	Description
confidence	integer	字詞指派的信賴度。
createdBy	string	建立記錄的使用者。
description	string	字詞指派的描述。
displayText	string	顯示文字。
expression	string	字詞指派的表達式。
relationGuid	string	關聯性的 GUID。
status	AtlasTermAssignmentStatus	字詞指派的狀態。
steward	string	詞彙的管理者。
termGuid	string	詞彙的 GUID。

AtlasTermAssignmentStatus

字詞指派的狀態

名稱	類型	Description
DEPRECATED	string	狀態已被取代。
DISCOVERED	string	探索到狀態。
IMPORTED	string	狀態已匯入。
OBSOLETE	string	狀態已過時。
OTHER	string	其他狀態。
PROPOSED	string	建議狀態。
VALIDATED	string	狀態已驗證。

EntityStatus

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

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

TimeBoundary

擷取時間界限詳細數據

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

共用方式為