Entity - Bulk Create Or Update

  • リファレンス
サービス:
Purview
API バージョン:
2023-09-01

エンティティを一括で作成または更新します。 既存のエンティティは、指定された場合、またはその一意の属性 (例: qualifiedName) によって一意の guid を使用して照合されます。 コレクションのマップと配列は十分にサポートされていません。 たとえば、配列配列>、配列<<マップ<文字列、int>> などです。 連絡先の種類ごとに、連絡先の最大数は 20 です。

POST {endpoint}/datamap/api/atlas/v2/entity/bulk
省略可能なパラメーターを含む: 
POST {endpoint}/datamap/api/atlas/v2/entity/bulk?api-version=2023-09-01&collectionId={collectionId}&businessAttributeUpdateBehavior={businessAttributeUpdateBehavior}

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

api-version
 query

string

この操作に使用する API バージョン。
businessAttributeUpdateBehavior
 query

BusinessAttributeUpdateBehavior

エンティティを更新するときのビジネス属性の更新動作を定義するために使用されます。
collectionId
 query

string

エンティティの移動先のコレクション。 エンティティを別のコレクションに移動する必要がある場合にのみ、値を指定します。

要求本文

名前 型 説明
entities

AtlasEntity[]

エンティティの配列。
referredEntities

<string,  AtlasEntity>

参照されるエンティティ。

応答

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

要求のサンプル

POST {endpoint}/datamap/api/atlas/v2/entity/bulk?api-version=2023-09-01

{
  "referredEntities": {},
  "entities": [
    {
      "typeName": "azure_storage_account",
      "attributes": {
        "owner": "ExampleOwner",
        "modifiedTime": 0,
        "createTime": 0,
        "qualifiedName": "exampleaccount1",
        "name": "ExampleStorageAccount1",
        "description": null,
        "publicAccessLevel": null
      },
      "contacts": {
        "Expert": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Expert Info"
          }
        ],
        "Owner": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Owner Info"
          }
        ]
      },
      "status": "ACTIVE",
      "createdBy": "ExampleCreator",
      "updatedBy": "ExampleUpdator",
      "version": 0
    },
    {
      "typeName": "azure_storage_account",
      "attributes": {
        "owner": "ExampleOwner",
        "modifiedTime": 0,
        "createTime": 0,
        "qualifiedName": "exampleaccount2",
        "name": "ExampleStorageAccount2",
        "description": "Example Description",
        "publicAccessLevel": null
      },
      "contacts": {
        "Expert": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Expert Info"
          }
        ],
        "Owner": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Owner Info"
          }
        ]
      },
      "status": "ACTIVE",
      "createdBy": "ExampleCreator",
      "updatedBy": "ExampleUpdator",
      "version": 0
    }
  ]
}

応答のサンプル

状態コード:
200 
{
  "mutatedEntities": {
    "UPDATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "exampleaccount2"
        },
        "lastModifiedTS": "2",
        "guid": "b2f9c306-cf65-4bb0-878e-cfaafde156b1",
        "status": "ACTIVE"
      }
    ],
    "CREATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "exampleaccount1"
        },
        "lastModifiedTS": "1",
        "guid": "321493e3-3fb7-4b3e-9df7-3b69154174c2",
        "status": "ACTIVE"
      }
    ]
  },
  "guidAssignments": {
    "-9514774903018192": "321493e3-3fb7-4b3e-9df7-3b69154174c2",
    "-9514774903018193": "b2f9c306-cf65-4bb0-878e-cfaafde156b1"
  }
}

定義

名前 説明
AtlasClassification

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

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

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

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

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

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

用語割り当ての状態
BusinessAttributeUpdateBehavior

エンティティを更新するときのビジネス属性の更新動作を定義するために使用されます。
EntityMutationResult

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

状態 - アクティブまたは削除できます
TimeBoundary

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

AtlasClassification

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

名前 型 説明
attributes

構造体の属性。
entityGuid

string

エンティティの GUID。
entityStatus

EntityStatus

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

string

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

boolean

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

string

型の名前。
validityPeriods

TimeBoundary[]

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

AtlasEntitiesWithExtInfo

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

名前 型 説明
entities

AtlasEntity[]

エンティティの配列。
referredEntities

<string,  AtlasEntity>

参照されるエンティティ。

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

エンティティのバージョン。

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

状態が検証されます。

BusinessAttributeUpdateBehavior

エンティティを更新するときのビジネス属性の更新動作を定義するために使用されます。

名前 型 説明
ignore

string

更新のビジネス属性ペイロードを無視します。
merge

string

ビジネス属性をマージします。 指定されていない場合、ビジネス属性は更新されません。
replace

string

ペイロードを使用して、すべてのビジネス属性を置き換えます。

EntityMutationResult

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

名前 型 説明
guidAssignments

object

エンティティを含む GUID 割り当てのマップ。
mutatedEntities

object

変更されたエンティティのエンティティ ヘッダー。
partialUpdatedEntities

AtlasEntityHeader[]

部分的に更新されたエンティティ ヘッダーの配列。

EntityStatus

状態 - アクティブまたは削除できます

名前 型 説明
ACTIVE

string

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

string

状態が削除されます。

TimeBoundary

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

名前 型 説明
endTime

string

時間境界の終わり。
startTime

string

時間境界の開始。
timeZone

string

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