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

名前	/	必須	型	説明
endpoint	path	True	string
guid	path	True	string	エンティティのグローバル一意識別子。
ignoreRelationships	query		boolean	リレーションシップ属性を無視するかどうか。
minExtInfo	query		boolean	参照されるエンティティの最小限の情報を返すかどうか。

応答

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

セキュリティ

OAuth2Auth

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

スコープ

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

定義

名前	説明
AtlasClassification	分類のインスタンス。ID がありません。このオブジェクトはエンティティに関連付けられている場合にのみ存在します。
AtlasEntity	エンティティのインスタンス (hive_table、hive_databaseなど)。
AtlasEntityWithExtInfo	エンティティのインスタンスと拡張情報 (hive_table、hive_databaseなど)。
AtlasErrorResponse	サービスからのエラー応答
AtlasTermAssignmentHeader	用語割り当てのヘッダー。
AtlasTermAssignmentStatus	用語割り当ての状態
EntityStatus	状態 - アクティブまたは削除できます
TimeBoundary	時間境界の詳細をキャプチャします

AtlasClassification

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

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

AtlasEntity

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

名前	型	説明
attributes		構造体の属性。
businessAttributes		ビジネス属性
classifications	AtlasClassification[]	分類の配列。
collectionId	string	エンティティのコレクション ID。
contacts	object	エンティティの連絡先のディクショナリ。キーには、エキスパートまたは所有者を指定できます。
createTime	integer	レコードの作成時刻。
createdBy	string	レコードを作成したユーザー。
customAttributes	object	カスタム属性
guid	string	エンティティの GUID。
homeId	string	エンティティのホーム ID。
isIncomplete	boolean	シェルエンティティかどうか
labels	string[]	labels
lastModifiedTS	string	コンカレンシー制御の ETag。
meanings	AtlasTermAssignmentHeader[]	エンティティの意味を示す用語代入ヘッダーの配列。
provenanceType	integer	エンティティまたはリレーションシップのインスタンスの証明を記録するために使用されます。
proxy	boolean	プロキシがあるかどうかを判断します。
relationshipAttributes		リレーションシップの属性。
status	EntityStatus	エンティティの状態 - アクティブまたは削除できます。削除されたエンティティは削除されません。
typeName	string	型の名前。
updateTime	integer	レコードの更新時刻。
updatedBy	string	レコードを更新したユーザー。
version	integer	エンティティのバージョン。

AtlasEntityWithExtInfo

エンティティのインスタンスと拡張情報 (hive_table、hive_databaseなど)。

名前	型	説明
entity	AtlasEntity	エンティティのインスタンス (hive_table、hive_databaseなど)。
referredEntities	<string, AtlasEntity>	参照されるエンティティ。

AtlasErrorResponse

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

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

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

TimeBoundary

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

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

次の方法で共有