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 パラメーター

名前	/	必須	型	説明
endpoint	path	True	string
guid	path	True	string	リレーションシップのグローバル一意識別子。
extendedInfo	query		boolean	拡張情報を含めるかどうかを制限します。

応答

名前	型	説明
200 OK	AtlasRelationshipWithExtInfo	要求は成功しました。
Other Status Codes	AtlasErrorResponse	予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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
  }
}

定義

名前	説明
AtlasClassification	分類のインスタンス。ID がありません。このオブジェクトはエンティティに関連付けられている場合にのみ存在します。
AtlasEntityHeader	エンティティのインスタンス (hive_table、hive_databaseなど)。
AtlasErrorResponse	サービスからのエラー応答
AtlasObjectId	エンティティのような型のオブジェクトインスタンスへの参照。
AtlasRelationship	Atlas リレーションシップインスタンス。
AtlasRelationshipWithExtInfo	拡張情報を含むリレーションシップ。
AtlasTermAssignmentHeader	用語割り当てのヘッダー。
AtlasTermAssignmentStatus	用語割り当ての状態
EntityStatus	状態 - アクティブまたは削除可能
StatusAtlasRelationship	Atlas リレーションシップの状態
TimeBoundary	時間境界の詳細をキャプチャします

AtlasClassification

分類のインスタンス。ID がありません。このオブジェクトはエンティティに関連付けられている場合にのみ存在します。

名前	型	説明
attributes		構造体の属性。
entityGuid	string	エンティティの GUID。
entityStatus	EntityStatus	エンティティの状態 - アクティブまたは削除できます。削除されたエンティティは削除されません。
lastModifiedTS	string	コンカレンシー制御の ETag。
removePropagationsOnEntityDelete	boolean	エンティティの削除時に伝達を削除するかどうかを決定します。
typeName	string	型の名前。
validityPeriods	TimeBoundary[]	有効期間を示す時間境界の配列。

AtlasEntityHeader

エンティティのインスタンス (hive_table、hive_databaseなど)。

名前	型	説明
attributes		構造体の属性。
classificationNames	string[]	分類名の配列。
classifications	AtlasClassification[]	分類の配列。
displayText	string	表示テキスト。
guid	string	レコードの GUID。
isIncomplete	boolean	シェルエンティティかどうか
labels	string[]	labels
lastModifiedTS	string	コンカレンシー制御の ETag。
meaningNames	string[]	意味の配列。
meanings	AtlasTermAssignmentHeader[]	用語の割り当てヘッダーの配列。
status	EntityStatus	エンティティの状態 - アクティブまたは削除できます。削除されたエンティティは削除されません。
typeName	string	型の名前。

AtlasErrorResponse

サービスからのエラー応答

名前	型	説明
errorCode	string	エラーコード。
errorMessage	string	エラーメッセージ。
requestId	string	要求 ID です。

AtlasObjectId

エンティティのような型のオブジェクトインスタンスへの参照。

名前	型	説明
guid	string	オブジェクトの GUID。
typeName	string	型の名前。
uniqueAttributes		オブジェクトの一意の属性。

AtlasRelationship

Atlas リレーションシップインスタンス。

名前	型	説明
attributes		構造体の属性。
createTime	integer	レコードの作成時刻。
createdBy	string	レコードを作成したユーザー。
end1	AtlasObjectId	エンティティのような型のオブジェクトインスタンスへの参照。
end2	AtlasObjectId	エンティティのような型のオブジェクトインスタンスへの参照。
guid	string	リレーションシップの GUID。
homeId	string	リレーションシップのホーム ID。
label	string	リレーションシップのラベル。
lastModifiedTS	string	コンカレンシー制御の ETag。
provenanceType	integer	エンティティまたはリレーションシップのインスタンスの証明を記録するために使用されます
status	StatusAtlasRelationship	リレーションシップの状態の列挙型。
typeName	string	型の名前。
updateTime	integer	レコードの更新時刻。
updatedBy	string	レコードを更新したユーザー。
version	integer	リレーションシップのバージョン。

AtlasRelationshipWithExtInfo

拡張情報を含むリレーションシップ。

名前	型	説明
referredEntities	<string, AtlasEntityHeader>	参照されるエンティティヘッダー。
relationship	AtlasRelationship	Atlas リレーションシップインスタンス。

AtlasTermAssignmentHeader

用語割り当てのヘッダー。

名前	型	説明
confidence	integer	用語の割り当ての信頼度。
createdBy	string	レコードを作成したユーザー。
description	string	用語の割り当ての説明。
displayText	string	表示テキスト。
expression	string	代入という用語の式。
relationGuid	string	リレーションシップの GUID。
status	AtlasTermAssignmentStatus	用語の割り当ての状態。
steward	string	用語のスチュワード。
termGuid	string	用語の GUID。

AtlasTermAssignmentStatus

用語割り当ての状態

名前	型	説明
DEPRECATED	string	状態は非推奨です。
DISCOVERED	string	状態が検出されました。
IMPORTED	string	状態がインポートされます。
OBSOLETE	string	状態は古くなっています。
OTHER	string	その他の状態。
PROPOSED	string	状態が提案されます。
VALIDATED	string	状態が検証されます。

EntityStatus

状態 - アクティブまたは削除可能

名前	型	説明
ACTIVE	string	状態がアクティブです。
DELETED	string	状態が削除されます。

StatusAtlasRelationship

Atlas リレーションシップの状態

名前	型	説明
ACTIVE	string	active
DELETED	string	deleted

TimeBoundary

時間境界の詳細をキャプチャします

名前	型	説明
endTime	string	時間境界の終わり。
startTime	string	時間境界の開始。
timeZone	string	時間境界のタイムゾーン。

次の方法で共有