Entity - Move Entities To Collection

服務:

Purview

API 版本:

2023-09-01

將現有的實體移至目標集合。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string (uri)
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。
collectionId	query	True	string	將移至實體的集合。

要求本文

名稱	類型	Description
entityGuids	string[]	要移至目標集合的實體 GUID 陣列。

回應

名稱	類型	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_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"
  }
}

定義

名稱	Description
AtlasClassification	分類的實例;它沒有身分識別，此物件只有在與實體相關聯時才會存在。
AtlasEntityHeader	實體的實例 ，例如hive_table，hive_database。
AtlasErrorResponse	來自服務的錯誤回應
AtlasTermAssignmentHeader	字詞指派的標頭。
AtlasTermAssignmentStatus	字詞指派的狀態
EntityMutationResult	實體的突變回應結果。
EntityStatus	狀態 - 可以是使用中或刪除
MoveEntitiesOptions	MoveEntitiesOptions
TimeBoundary	擷取時間界限詳細數據

AtlasClassification

Object

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

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

AtlasEntityHeader

Object

實體的實例 ，例如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

Object

來自服務的錯誤回應

名稱	類型	Description
errorCode	string	錯誤碼。
errorMessage	string	錯誤訊息。
requestId	string (uuid)	要求標識碼。

AtlasTermAssignmentHeader

Object

字詞指派的標頭。

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

AtlasTermAssignmentStatus

列舉型別

字詞指派的狀態

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

EntityMutationResult

Object

實體的突變回應結果。

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

EntityStatus

列舉型別

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

值	Description
ACTIVE	狀態為作用中。
DELETED	狀態已刪除。

MoveEntitiesOptions

Object

MoveEntitiesOptions

名稱	類型	Description
entityGuids	string[]	要移至目標集合的實體 GUID 陣列。

TimeBoundary

Object

擷取時間界限詳細數據

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