次の方法で共有

Lineage - Get

サービス:
Purview
API バージョン:
2023-09-01

GUID で指定されたエンティティの系列情報を取得します。

GET {endpoint}/datamap/api/atlas/v2/lineage/{guid}?direction={direction}
省略可能なパラメーターを含む: 
GET {endpoint}/datamap/api/atlas/v2/lineage/{guid}?depth={depth}&direction={direction}

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string (uri)

guid
 path True

string

エンティティのグローバル一意識別子。
direction
 query True

LineageDirection

系列の方向 。INPUT、OUTPUT、BOTH のいずれかです。
depth
 query

integer (int32)

系列のホップ数。

応答

名前 型 説明
200 OK

AtlasLineageInfo

要求は成功しました。
Other Status Codes

AtlasErrorResponse

予期しないエラー応答。

セキュリティ

OAuth2Auth

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

スコープ

名前 説明
https://purview.azure.net/.default

例

Lineage_Get

要求のサンプル

GET {endpoint}/datamap/api/atlas/v2/lineage/a6894eb3-81f3-829b-2adc-52f3e603411a?depth=1&direction=INPUT

応答のサンプル

状態コード:
200 
{
  "baseEntityGuid": "a6894eb3-81f3-829b-2adc-52f3e603411a",
  "lineageDirection": "INPUT",
  "lineageDepth": 1,
  "lineageWidth": 1,
  "childrenCount": 1,
  "guidEntityMap": {},
  "widthCounts": {},
  "relations": [],
  "parentRelations": []
}

定義

名前 説明
AtlasClassification

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

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

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

系列情報。
AtlasTermAssignmentHeader

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

用語割り当ての状態
EntityStatus

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

系列の方向
LineageRelation

from エンティティと to エンティティの GUID との系列関係。
ParentRelation

系列親は、親エンティティの GUID と子エンティティとの関係です。
TimeBoundary

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

AtlasClassification

Object

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

名前 型 説明
attributes

構造体の属性。
entityGuid

string

エンティティの GUID。
entityStatus

EntityStatus

エンティティの状態 - アクティブまたは削除できます。 削除されたエンティティは削除されません。
lastModifiedTS

string

コンカレンシー制御の ETag。
removePropagationsOnEntityDelete

boolean

エンティティの削除時に伝達を削除するかどうかを決定します。
typeName

string

型の名前。
validityPeriods

TimeBoundary[]

有効期間を示す時間境界の配列。

AtlasEntityHeader

Object

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

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

Object

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

名前 型 説明
errorCode

string

エラー コード。
errorMessage

string

エラー メッセージ。
requestId

string (uuid)

要求 ID。

AtlasLineageInfo

Object

系列情報。

名前 型 説明
baseEntityGuid

string

基本エンティティの GUID。
childrenCount

integer (int32)

子ノードの数。
guidEntityMap

<string,  AtlasEntityHeader>

GUID エンティティ マップ。
lineageDepth

integer (int32)

系列の深さ。
lineageDirection

LineageDirection

系列の方向の列挙型。
lineageWidth

integer (int32)

系列の幅。
parentRelations

ParentRelation[]

parentRelations リレーションの配列。
relations

LineageRelation[]

系列関係の配列。
widthCounts

object

特定の方向のエンティティ数。

AtlasTermAssignmentHeader

Object

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

名前 型 説明
confidence

integer (int32)

用語の割り当ての信頼度。
createdBy

string

レコードを作成したユーザー。
description

string

用語の割り当ての説明。
displayText

string

表示テキスト。
expression

string

用語の割り当ての式。
relationGuid

string (uuid)

リレーションシップの GUID。
status

AtlasTermAssignmentStatus

用語の割り当ての状態。
steward

string

用語のスチュワード。
termGuid

string (uuid)

用語の GUID。

AtlasTermAssignmentStatus

列挙

用語割り当ての状態

値 説明
DISCOVERED

状態が検出されました。
PROPOSED

状態が提案されます。
IMPORTED

状態がインポートされます。
VALIDATED

状態が検証されます。
DEPRECATED

状態は非推奨です。
OBSOLETE

状態は廃止されています。
OTHER

その他の状態。

EntityStatus

列挙

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

値 説明
ACTIVE

状態はアクティブです。
DELETED

状態が削除されます。

LineageDirection

列挙

系列の方向

値 説明
INPUT

入力
OUTPUT

出力
BOTH

両方

LineageRelation

Object

from エンティティと to エンティティの GUID との系列関係。

名前 型 説明
fromEntityId

string

from-entity の GUID。
relationshipId

string

リレーションシップの GUID。
toEntityId

string

エンティティ間の GUID。

ParentRelation

Object

系列親は、親エンティティの GUID と子エンティティとの関係です。

名前 型 説明
childEntityId

string

子エンティティの GUID。
parentEntityId

string

親エンティティの GUID。
relationshipId

string

リレーションシップの GUID。

TimeBoundary

Object

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

名前 型 説明
endTime

string

時間境界の終わり。
startTime

string

時間境界の開始。
timeZone

string

時間境界のタイムゾーン。