Relationship - Get

參考

服務:: Purview

API 版本:: 2023-09-01

依實體 GUID 取得實體之間的關聯性資訊。

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

含選擇性參數:

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/{guid}?extendedInfo={extendedInfo}

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string
guid	path	True	string	關聯性的全域唯一標識符。
extendedInfo	query		boolean	限制是否包含擴充資訊。

回應

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

安全性

OAuth2Auth

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

範圍

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

範例

Relationship_Get

範例要求

HTTP

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb?extendedInfo=false

範例回覆

狀態碼:: 200

{
  "relationship": {
    "typeName": "AtlasGlossarySynonym",
    "attributes": {
      "expression": null,
      "steward": null,
      "description": null,
      "source": null,
      "status": null
    },
    "guid": "de23cd5a-021c-413d-98a5-98752a1f7a3b",
    "end1": {
      "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6",
      "typeName": "AtlasGlossaryTerm"
    },
    "end2": {
      "guid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef",
      "typeName": "AtlasGlossaryTerm"
    },
    "label": "r:AtlasGlossarySynonym",
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "createTime": 1553838993803,
    "updateTime": 1553838993803,
    "version": 0
  }
}

定義

名稱	Description
AtlasClassification	分類的實例;它沒有身分識別，只有與實體相關聯的物件存在。
AtlasEntityHeader	實體的實例，例如hive_table，hive_database。
AtlasErrorResponse	來自服務的錯誤回應
AtlasObjectId	型別的物件實例參考 - 例如實體。
AtlasRelationship	Atlas 關聯性實例。
AtlasRelationshipWithExtInfo	具有擴充信息的關係。
AtlasTermAssignmentHeader	字詞指派的標頭。
AtlasTermAssignmentStatus	字詞指派的狀態
EntityStatus	狀態 - 可以是作用中或刪除
StatusAtlasRelationship	atlas 關聯性的狀態
TimeBoundary	擷取時間界限詳細數據

AtlasClassification

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

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

AtlasEntityHeader

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

名稱	類型	Description
attributes		結構的屬性。
classificationNames	string[]	分類名稱的陣列。
classifications	AtlasClassification[]	分類陣列。
displayText	string	顯示文字。
guid	string	記錄的 GUID。
isIncomplete	boolean	它是否為殼層實體
labels	string[]	標籤
lastModifiedTS	string	並行控制的 ETag。
meaningNames	string[]	意義陣列。
meanings	AtlasTermAssignmentHeader[]	字詞指派標頭的陣列。
status	EntityStatus	實體的狀態 - 可以是作用中或刪除。不會移除已刪除的實體。
typeName	string	型別的名稱。

AtlasErrorResponse

來自服務的錯誤回應

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

AtlasObjectId

型別的物件實例參考 - 例如實體。

名稱	類型	Description
guid	string	物件的 GUID。
typeName	string	型別的名稱。
uniqueAttributes		物件的唯一屬性。

AtlasRelationship

Atlas 關聯性實例。

名稱	類型	Description
attributes		結構的屬性。
createTime	integer	記錄的建立時間。
createdBy	string	建立記錄的使用者。
end1	AtlasObjectId	型別的物件實例參考 - 例如實體。
end2	AtlasObjectId	型別的物件實例參考 - 例如實體。
guid	string	關聯性的 GUID。
homeId	string	關聯性的主標識碼。
label	string	關聯性的標籤。
lastModifiedTS	string	並行控制的 ETag。
provenanceType	integer	用來記錄實體或關聯性實例的證明
status	StatusAtlasRelationship	關聯性狀態的列舉。
typeName	string	型別的名稱。
updateTime	integer	記錄的更新時間。
updatedBy	string	更新記錄的使用者。
version	integer	關聯性的版本。

AtlasRelationshipWithExtInfo

具有擴充信息的關係。

名稱	類型	Description
referredEntities	<string, AtlasEntityHeader>	參考的實體標頭。
relationship	AtlasRelationship	Atlas 關聯性實例。

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	狀態已刪除。

StatusAtlasRelationship

atlas 關聯性的狀態

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

TimeBoundary

擷取時間界限詳細數據

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

共用方式為