共用方式為


Entity - Partial Update By Unique Attributes

部分更新實體 - 允許在其類型和唯一屬性所識別的實體上更新屬性子集,例如 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 參數

名稱 位於 必要 類型 Description
endpoint
path True

string

typeName
path True

string

型別的名稱。

attr:qualifiedName
query

string

實體的限定名稱。 (這隻是範例。qualifiedName 可以變更為其他唯一屬性)

要求本文

名稱 類型 Description
entity

AtlasEntity

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

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_PartialUpdateByUniqueAttributes

範例要求

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

範例回覆

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

定義

名稱 Description
AtlasClassification

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

AtlasEntity

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

AtlasEntityHeader

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

AtlasEntityWithExtInfo

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

AtlasErrorResponse

來自服務的錯誤回應

AtlasTermAssignmentHeader

字詞指派的標頭。

AtlasTermAssignmentStatus

字詞指派的狀態

EntityMutationResult

實體的變動回應結果。

EntityStatus

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

TimeBoundary

擷取時間界限詳細數據

AtlasClassification

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

名稱 類型 Description
attributes

結構的屬性。

entityGuid

string

實體的 GUID。

entityStatus

EntityStatus

實體的狀態 - 可以是作用中或刪除。 不會移除已刪除的實體。

lastModifiedTS

string

並行控制的 ETag。

removePropagationsOnEntityDelete

boolean

判斷是否會在實體刪除時移除傳播。

typeName

string

型別的名稱。

validityPeriods

TimeBoundary[]

指出有效期間的時間界限陣列。

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

型別的名稱。

AtlasEntityWithExtInfo

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

名稱 類型 Description
entity

AtlasEntity

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

referredEntities

<string,  AtlasEntity>

參考的實體。

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

狀態已驗證。

EntityMutationResult

實體的變動回應結果。

名稱 類型 Description
guidAssignments

object

具有實體之 GUID 指派的對應。

mutatedEntities

object

變動實體的實體標頭。

partialUpdatedEntities

AtlasEntityHeader[]

部分更新的實體標頭陣列。

EntityStatus

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

名稱 類型 Description
ACTIVE

string

狀態為作用中。

DELETED

string

狀態已刪除。

TimeBoundary

擷取時間界限詳細數據

名稱 類型 Description
endTime

string

時間界限的結尾。

startTime

string

時間界限的開始。

timeZone

string

時間界限的時區。