Lineage - Get By Unique Attribute

リファレンス

サービス:: Purview

API バージョン:: 2023-09-01

エンティティに関する系列情報を返します。

typeName パスパラメーターに加えて、属性のキーと値のペアは次の形式で指定できます。

attr:[attrName]=[attrValue]

注: attrName と attrValue は、エンティティ間で一意である必要があります(例: )。qualifiedName。

REST 要求は次のようになります。

GET /v2/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue。

GET {endpoint}/datamap/api/atlas/v2/lineage/uniqueAttribute/type/{typeName}?direction={direction}

省略可能なパラメーターを含む:

GET {endpoint}/datamap/api/atlas/v2/lineage/uniqueAttribute/type/{typeName}?depth={depth}&direction={direction}&attr:qualifiedName={attr:qualifiedName}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string
typeName	path	True	string	型の名前。
direction	query	True	LineageDirection	系列の方向。INPUT、OUTPUT、または BOTH のいずれかです。
attr:qualifiedName	query		string	エンティティの修飾名。 (これはほんの一例です。qualifiedName は他の一意の属性に変更できます)
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_GetByUniqueAttribute

要求のサンプル

HTTP

GET {endpoint}/datamap/api/atlas/v2/lineage/uniqueAttribute/type/azure_blob_path?depth=2&direction=BOTH&attr:qualifiedName=https://02cab97b-ba87-4675-972d-150b6cb522d3/entity.json/

応答のサンプル

状態コード:: 200

{
  "baseEntityGuid": "9b2751f1-2633-4f06-a578-e14fab4c52fd",
  "lineageDirection": "BOTH",
  "lineageDepth": 2,
  "lineageWidth": 2,
  "childrenCount": -1,
  "guidEntityMap": {
    "9b2751f1-2633-4f06-a578-e14fab4c52fd": {
      "typeName": "azure_blob_path",
      "attributes": {
        "owner": "testOwner",
        "modifiedTime": 0,
        "qualifiedName": "https://02cab97b-ba87-4675-972d-150b6cb522d3/entity.json/",
        "isBlob": false,
        "accessTierInferred": false,
        "description": "testDesc",
        "committedBlockCount": 0,
        "path": "/test/AzureBlobPath.json",
        "size": 731,
        "createTime": 0,
        "name": "populate_azure_blob_path_02cab97b-ba87-4675-972d-150b6cb522d3",
        "blobType": "BlockBlob",
        "serverEncrypted": true
      },
      "lastModifiedTS": "1",
      "guid": "9b2751f1-2633-4f06-a578-e14fab4c52fd",
      "status": "ACTIVE",
      "displayText": "populate_azure_blob_path_02cab97b-ba87-4675-972d-150b6cb522d3",
      "classificationNames": [
        "MICROSOFT.PERSONAL.EMAIL",
        "MICROSOFT.PERSONAL.NAME"
      ],
      "meaningNames": [],
      "meanings": [],
      "isIncomplete": false,
      "labels": []
    }
  },
  "relations": [],
  "parentRelations": [],
  "widthCounts": {
    "INPUT": {
      "9b2751f1-2633-4f06-a578-e14fab4c52fd": 0
    },
    "OUTPUT": {
      "9b2751f1-2633-4f06-a578-e14fab4c52fd": 0
    }
  }
}

定義

名前	説明
AtlasClassification	分類のインスタンス。ID がありません。このオブジェクトはエンティティに関連付けられている場合にのみ存在します。
AtlasEntityHeader	エンティティのインスタンス (hive_table、hive_databaseなど)。
AtlasErrorResponse	サービスからのエラー応答
AtlasLineageInfo	系列情報。
AtlasTermAssignmentHeader	用語割り当てのヘッダー。
AtlasTermAssignmentStatus	用語割り当ての状態
EntityStatus	状態 - アクティブまたは削除可能
LineageDirection	系列の方向
LineageRelation	from エンティティと to エンティティの GUID との系列関係。
ParentRelation	系列の親は、親エンティティの GUID と子エンティティとの関係です。
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 です。

AtlasLineageInfo

系列情報。

名前	型	説明
baseEntityGuid	string	基本エンティティの GUID。
childrenCount	integer	子ノードの数。
guidEntityMap	<string, AtlasEntityHeader>	GUID エンティティマップ。
lineageDepth	integer	系列の深さ。
lineageDirection	LineageDirection	系列の方向の列挙型。
lineageWidth	integer	系列の幅。
parentRelations	ParentRelation[]	parentRelations リレーションの配列。
relations	LineageRelation[]	系列関係の配列。
widthCounts	object	特定の方向のエンティティ数。

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	状態が削除されます。

LineageDirection

系列の方向

名前	型	説明
BOTH	string	両方
INPUT	string	input
OUTPUT	string	output

LineageRelation

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

名前	型	説明
fromEntityId	string	from-entity の GUID。
relationshipId	string	リレーションシップの GUID。
toEntityId	string	エンティティ間の GUID。

ParentRelation

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

名前	型	説明
childEntityId	string	子エンティティの GUID。
parentEntityId	string	親エンティティの GUID。
relationshipId	string	リレーションシップの GUID。

TimeBoundary

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

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

次の方法で共有