Entity - Bulk Create Or Update

參考

服務:: Purview

API 版本:: 2023-09-01

大量建立或更新實體。如果提供或由唯一屬性提供，則現有的實體會使用其唯一 GUID 進行比對，例如： qualifiedName。不支援集合的對應和陣列。例如陣列數位列、陣列<<對應<字串、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 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string
api-version	query		string	用於此作業的 API 版本。
businessAttributeUpdateBehavior	query		BusinessAttributeUpdateBehavior	用來定義更新實體時商務屬性的更新行為。
collectionId	query		string	實體將移至其中的集合。只有在您需要將實體移至另一個集合時，才指定值。

要求本文

名稱	類型	Description
entities	AtlasEntity[]	實體數位。
referredEntities	<string, AtlasEntity>	參考的實體。

回應

名稱	類型	Description
200 OK	EntityMutationResult	要求已成功。
Other Status Codes	AtlasErrorResponse	未預期的錯誤回應。

安全性

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
https://purview.azure.net/.default

範例

Entity_BulkCreateOrUpdate

範例要求

HTTP

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"
  }
}

定義

名稱	Description
AtlasClassification	分類的實例;它沒有身分識別，只有與實體相關聯的物件存在。
AtlasEntitiesWithExtInfo	實體的實例以及擴充資訊，例如hive_table，hive_database。
AtlasEntity	實體的實例，例如hive_table，hive_database。
AtlasEntityHeader	實體的實例，例如hive_table，hive_database。
AtlasErrorResponse	來自服務的錯誤回應
AtlasTermAssignmentHeader	字詞指派的標頭。
AtlasTermAssignmentStatus	字詞指派的狀態
BusinessAttributeUpdateBehavior	用來定義更新實體時商務屬性的更新行為。
EntityMutationResult	實體的變動回應結果。
EntityStatus	狀態 - 可以是作用中或刪除
TimeBoundary	擷取時間界限詳細數據

AtlasClassification

分類的實例;它沒有身分識別，只有與實體相關聯的物件存在。

名稱	類型	Description
attributes		結構的屬性。
entityGuid	string	實體的 GUID。
entityStatus	EntityStatus	實體的狀態 - 可以是作用中或刪除。不會移除已刪除的實體。
lastModifiedTS	string	並行控制的 ETag。
removePropagationsOnEntityDelete	boolean	判斷是否會在實體刪除時移除傳播。
typeName	string	型別的名稱。
validityPeriods	TimeBoundary[]	指出有效期間的時間界限陣列。

AtlasEntitiesWithExtInfo

實體的實例以及擴充資訊，例如hive_table，hive_database。

名稱	類型	Description
entities	AtlasEntity[]	實體數位。
referredEntities	<string, AtlasEntity>	參考的實體。

AtlasEntity

實體的實例，例如hive_table，hive_database。

名稱	類型	Description
attributes		結構的屬性。
businessAttributes		商務屬性
classifications	AtlasClassification[]	分類陣列。
collectionId	string	實體的集合標識碼。
contacts	object	實體聯繫人的字典。索引鍵可以是專家或擁有者。
createTime	integer	記錄的建立時間。
createdBy	string	建立記錄的使用者。
customAttributes	object	自訂屬性
guid	string	實體的 GUID。
homeId	string	實體的主標識碼。
isIncomplete	boolean	它是否為殼層實體
labels	string[]	標籤
lastModifiedTS	string	並行控制的 ETag。
meanings	AtlasTermAssignmentHeader[]	詞彙指派標頭的陣列，表示實體的意義。
provenanceType	integer	用來記錄實體或關聯性實例的證明。
proxy	boolean	判斷是否有 Proxy。
relationshipAttributes		關聯性的屬性。
status	EntityStatus	實體的狀態 - 可以是作用中或刪除。不會移除已刪除的實體。
typeName	string	型別的名稱。
updateTime	integer	記錄的更新時間。
updatedBy	string	更新記錄的使用者。
version	integer	實體的版本。

AtlasEntityHeader

實體的實例，例如hive_table，hive_database。

名稱	類型	Description
attributes		結構的屬性。
classificationNames	string[]	分類名稱的陣列。
classifications	AtlasClassification[]	分類陣列。
displayText	string	顯示文字。
guid	string	記錄的 GUID。
isIncomplete	boolean	它是否為殼層實體
labels	string[]	標籤
lastModifiedTS	string	並行控制的 ETag。
meaningNames	string[]	意義陣列。
meanings	AtlasTermAssignmentHeader[]	字詞指派標頭的陣列。
status	EntityStatus	實體的狀態 - 可以是作用中或刪除。不會移除已刪除的實體。
typeName	string	型別的名稱。

AtlasErrorResponse

來自服務的錯誤回應

名稱	類型	Description
errorCode	string	錯誤碼。
errorMessage	string	錯誤訊息。
requestId	string	要求識別碼。

AtlasTermAssignmentHeader

字詞指派的標頭。

名稱	類型	Description
confidence	integer	字詞指派的信賴度。
createdBy	string	建立記錄的使用者。
description	string	指派一詞的描述。
displayText	string	顯示文字。
expression	string	字詞指派的表達式。
relationGuid	string	關聯性的 GUID。
status	AtlasTermAssignmentStatus	條款指派的狀態。
steward	string	詞彙的負責人。
termGuid	string	詞彙的 GUID。

AtlasTermAssignmentStatus

字詞指派的狀態

名稱	類型	Description
DEPRECATED	string	狀態已被取代。
DISCOVERED	string	探索到狀態。
IMPORTED	string	狀態已匯入。
OBSOLETE	string	狀態已過時。
OTHER	string	其他狀態。
PROPOSED	string	建議狀態。
VALIDATED	string	狀態已驗證。

BusinessAttributeUpdateBehavior

用來定義更新實體時商務屬性的更新行為。

名稱	類型	Description
ignore	string	忽略要更新的商務屬性承載。
merge	string	合併商務屬性。如果未提供，則不會更新商務屬性。
replace	string	使用承載取代所有商務屬性。

EntityMutationResult

實體的變動回應結果。

名稱	類型	Description
guidAssignments	object	具有實體之 GUID 指派的對應。
mutatedEntities	object	變動實體的實體標頭。
partialUpdatedEntities	AtlasEntityHeader[]	部分更新的實體標頭陣列。

EntityStatus

狀態 - 可以是作用中或刪除

名稱	類型	Description
ACTIVE	string	狀態為作用中。
DELETED	string	狀態已刪除。

TimeBoundary

擷取時間界限詳細數據

名稱	類型	Description
endTime	string	時間界限的結尾。
startTime	string	時間界限的開始。
timeZone	string	時間界限的時區。

共用方式為