Entity - Partial Update By Unique Attributes

リファレンス

サービス:: Purview

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

エンティティを部分的に更新する - 型と一意の属性によって識別されるエンティティで属性のサブセットを更新できるようにします (例: Referenceable.qualifiedName)。 Null 更新はできません。

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

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

REST 要求は、PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue のようになります。

PUT {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}

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

PUT {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}?attr:qualifiedName={attr:qualifiedName}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string
typeName	path	True	string	型の名前。
attr:qualifiedName	query		string	エンティティの修飾名。 (これはほんの一例です。qualifiedName は他の一意の属性に変更できます)

要求本文

名前	型	説明
entity	AtlasEntity	エンティティのインスタンス (hive_table、hive_databaseなど)。
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_PartialUpdateByUniqueAttributes

要求のサンプル

HTTP

PUT {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/azure_storage_account?attr:qualifiedName=https://exampleaccount.core.windows.net

{
  "entity": {
    "createTime": 1605766397985,
    "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
    "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0",
    "relationshipAttributes": {
      "services": [],
      "meanings": []
    },
    "status": "ACTIVE",
    "updateTime": 1605766397985,
    "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
    "lastModifiedTS": "1",
    "version": 0,
    "attributes": {
      "owner": "ExampleOwner",
      "qualifiedName": "https://exampleaccount.core.windows.net",
      "createTime": 0,
      "name": "ExampleNewName"
    },
    "typeName": "azure_storage_account"
  },
  "referredEntities": {}
}

応答のサンプル

状態コード:: 200

{
  "guidAssignments": {},
  "mutatedEntities": {
    "PARTIAL_UPDATE": [
      {
        "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0",
        "lastModifiedTS": "2",
        "attributes": {
          "qualifiedName": "https://exampleaccount.core.windows.net"
        },
        "typeName": "azure_storage_account"
      }
    ]
  },
  "partialUpdatedEntities": [
    {
      "guid": "dc507ccf-0c57-4165-9327-f37b0d13fda0",
      "lastModifiedTS": "2",
      "attributes": {
        "qualifiedName": "https://exampleaccount.core.windows.net"
      },
      "typeName": "azure_storage_account"
    }
  ]
}

定義

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

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	型の名前。

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

EntityMutationResult

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

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

EntityStatus

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

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

TimeBoundary

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

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

次の方法で共有