Entity - List By Unique Attributes
一意の属性で識別されるエンティティの一覧を取得する一括 API。 typeName パス パラメーターに加えて、属性のキーと値のペアを次の形式で指定できます。
typeName=<typeName>&attr_1:<attrName>=<attrValue>&attr_2:<attrName>=<attrValue>&attr_3:<attrName>=<attrValue>
注: attrName は、指定されたエンティティ型の一意の属性である必要があります。 REST 要求は次のようになります
GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1
注: 少なくとも 1 つの一意の属性を指定する必要があります。
GET {endpoint}/datamap/api/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}
GET {endpoint}/datamap/api/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}?minExtInfo={minExtInfo}&ignoreRelationships={ignoreRelationships}&attr_N:qualifiedName={attr_N:qualifiedName}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
endpoint
|
path | True |
string |
|
type
|
path | True |
string |
型の名前。 |
attr_N:qualified
|
query |
string |
エンティティの修飾名。 たとえば、2 つのエンティティを検索するには、attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1を設定できます。 (これは一例にすぎません。qualifiedName は他の一意の属性に変更できます) |
|
ignore
|
query |
boolean |
リレーションシップ属性を無視するかどうか。 |
|
min
|
query |
boolean |
参照されるエンティティの最小限の情報を返すかどうか。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
要求は成功しました。 |
|
Other Status Codes |
予期しないエラー応答。 |
セキュリティ
OAuth2Auth
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
https://purview.azure.net/.default |
例
Entity_ListByUniqueAttributes
要求のサンプル
GET {endpoint}/datamap/api/atlas/v2/entity/bulk/uniqueAttribute/type/azure_storage_account?minExtInfo=True&attr_N:qualifiedName=adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1
応答のサンプル
{
"referredEntities": {},
"entities": [
{
"typeName": "column",
"attributes": {
"owner": null,
"qualifiedName": "adl://exampleaccount.azuredatalakestore.net/123/1/DP_TFS/CBT/Extensions/DTTP.targets#:xml/Project/PropertyGroup/ExampleName1",
"name": "ExampleName1",
"description": null,
"type": "string"
},
"guid": "784c0f2f-afd2-e26b-f9cb-984f6c2c5021",
"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": "400fd8e4-97bd-45eb-a21c-880b4094ce5b",
"relationshipStatus": "ACTIVE",
"relationshipAttributes": {
"typeName": "tabular_schema_columns"
}
},
"meanings": [],
"outputFromProcesses": [],
"tabular_schema": null
}
}
]
}
定義
名前 | 説明 |
---|---|
Atlas |
分類のインスタンス。ID がありません。このオブジェクトはエンティティに関連付けられている場合にのみ存在します。 |
Atlas |
エンティティのインスタンスと拡張情報 (hive_table、hive_databaseなど)。 |
Atlas |
エンティティのインスタンス (hive_table、hive_databaseなど)。 |
Atlas |
サービスからのエラー応答 |
Atlas |
用語割り当てのヘッダー。 |
Atlas |
用語割り当ての状態 |
Entity |
状態 - アクティブまたは削除できます |
Time |
時間境界の詳細をキャプチャします |
AtlasClassification
分類のインスタンス。ID がありません。このオブジェクトはエンティティに関連付けられている場合にのみ存在します。
名前 | 型 | 説明 |
---|---|---|
attributes |
構造体の属性。 |
|
entityGuid |
string |
エンティティの GUID。 |
entityStatus |
エンティティの状態 - アクティブまたは削除できます。 削除されたエンティティは削除されません。 |
|
lastModifiedTS |
string |
コンカレンシー制御の ETag。 |
removePropagationsOnEntityDelete |
boolean |
エンティティの削除時に伝達を削除するかどうかを決定します。 |
typeName |
string |
型の名前。 |
validityPeriods |
有効期間を示す時間境界の配列。 |
AtlasEntitiesWithExtInfo
エンティティのインスタンスと拡張情報 (hive_table、hive_databaseなど)。
名前 | 型 | 説明 |
---|---|---|
entities |
エンティティの配列。 |
|
referredEntities |
<string,
Atlas |
参照されるエンティティ。 |
AtlasEntity
エンティティのインスタンス (hive_table、hive_databaseなど)。
名前 | 型 | 説明 |
---|---|---|
attributes |
構造体の属性。 |
|
businessAttributes |
ビジネス属性 |
|
classifications |
分類の配列。 |
|
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 |
エンティティの意味を示す用語代入ヘッダーの配列。 |
|
provenanceType |
integer |
エンティティまたはリレーションシップのインスタンスの証明を記録するために使用されます。 |
proxy |
boolean |
プロキシがあるかどうかを判断します。 |
relationshipAttributes |
リレーションシップの属性。 |
|
status |
エンティティの状態 - アクティブまたは削除できます。 削除されたエンティティは削除されません。 |
|
typeName |
string |
型の名前。 |
updateTime |
integer |
レコードの更新時刻。 |
updatedBy |
string |
レコードを更新したユーザー。 |
version |
integer |
エンティティのバージョン。 |
AtlasErrorResponse
サービスからのエラー応答
名前 | 型 | 説明 |
---|---|---|
errorCode |
string |
エラー コード。 |
errorMessage |
string |
エラー メッセージ。 |
requestId |
string |
要求 ID です。 |
AtlasTermAssignmentHeader
用語割り当てのヘッダー。
名前 | 型 | 説明 |
---|---|---|
confidence |
integer |
用語の割り当ての信頼度。 |
createdBy |
string |
レコードを作成したユーザー。 |
description |
string |
用語の割り当ての説明。 |
displayText |
string |
表示テキスト。 |
expression |
string |
代入という用語の式。 |
relationGuid |
string |
リレーションシップの GUID。 |
status |
用語の割り当ての状態。 |
|
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 |
時間境界のタイムゾーン。 |