Entity - Move Entities To Collection

リファレンス

サービス:: Purview

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

既存のエンティティをターゲットコレクションに移動します。

POST {endpoint}/datamap/api/entity/moveTo?api-version=2023-09-01&collectionId={collectionId}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string
api-version	query	True	string	この操作に使用する API バージョン。
collectionId	query	True	string	エンティティの移動先のコレクション。

要求本文

名前	型	説明
entityGuids	string[]	ターゲットコレクションに移動するエンティティ guid の配列。

応答

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

セキュリティ

OAuth2Auth

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

スコープ

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

例

Entity_MoveEntitiesToCollection

要求のサンプル

HTTP

POST {endpoint}/datamap/api/entity/moveTo?api-version=2023-09-01&collectionId=ExampleNewCollection

{
  "entityGuids": [
    "321493e3-3fb7-4b3e-9df7-3b69154174c2",
    "b2f9c306-cf65-4bb0-878e-cfaafde156b1"
  ]
}

応答のサンプル

状態コード:: 200

{
  "mutatedEntities": {
    "UPDATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "exampleaccount"
        },
        "lastModifiedTS": "3",
        "guid": "b2f9c306-cf65-4bb0-878e-cfaafde156b1",
        "status": "ACTIVE"
      },
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "exampleaccount2"
        },
        "lastModifiedTS": "2",
        "guid": "321493e3-3fb7-4b3e-9df7-3b69154174c2",
        "status": "ACTIVE"
      }
    ]
  },
  "guidAssignments": {
    "-9514774903018192": "321493e3-3fb7-4b3e-9df7-3b69154174c2",
    "-9514774903018193": "b2f9c306-cf65-4bb0-878e-cfaafde156b1"
  }
}

定義

名前	説明
AtlasClassification	分類のインスタンス。ID がありません。このオブジェクトはエンティティに関連付けられている場合にのみ存在します。
AtlasEntityHeader	エンティティのインスタンス (hive_table、hive_databaseなど)。
AtlasErrorResponse	サービスからのエラー応答
AtlasTermAssignmentHeader	用語割り当てのヘッダー。
AtlasTermAssignmentStatus	用語割り当ての状態
EntityMutationResult	エンティティのミューテーション応答の結果。
EntityStatus	状態 - アクティブまたは削除可能
MoveEntitiesOptions	MoveEntitiesOptions
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 です。

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

EntityMutationResult

エンティティのミューテーション応答の結果。

名前	型	説明
guidAssignments	object	エンティティを含む GUID 割り当てのマップ。
mutatedEntities	object	変更されたエンティティのエンティティヘッダー。
partialUpdatedEntities	AtlasEntityHeader[]	部分的に更新されたエンティティヘッダーの配列。

EntityStatus

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

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

MoveEntitiesOptions

名前	型	説明
entityGuids	string[]	ターゲットコレクションに移動するエンティティ guid の配列。

TimeBoundary

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

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

次の方法で共有