Partilhar via


Entity - Partial Update By Unique Attributes

Atualizar a entidade parcialmente – permita que um subconjunto de atributos seja atualizado numa entidade identificada pelo tipo e atributo exclusivo, por exemplo: Referenceable.qualifiedName. Não são possíveis atualizações nulas.

Além do parâmetro de caminho typeName, os pares de valor-chave de atributo podem ser fornecidos no seguinte formato:

attr:=. NOTA: o attrName e o attrValue devem ser exclusivos entre entidades, por exemplo. qualifiedName.

O pedido REST teria um aspeto semelhante ao seguinte: 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}

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
path True

string

typeName
path True

string

O nome do tipo.

attr:qualifiedName
query

string

O nome qualificado da entidade. (Este é apenas um exemplo. qualifiedName pode ser alterado para outros atributos exclusivos)

Corpo do Pedido

Name Tipo Description
entity

AtlasEntity

Uma instância de uma entidade , como hive_table, hive_database.

referredEntities

<string,  AtlasEntity>

As entidades referidas.

Respostas

Name Tipo Description
200 OK

EntityMutationResult

O pedido foi efetuada com êxito.

Other Status Codes

AtlasErrorResponse

Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
https://purview.azure.net/.default

Exemplos

Entity_PartialUpdateByUniqueAttributes

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
AtlasClassification

Uma instância de uma classificação; não tem uma identidade, este objeto só existe quando associado a uma entidade.

AtlasEntity

Uma instância de uma entidade , como hive_table, hive_database.

AtlasEntityHeader

Uma instância de uma entidade , como hive_table, hive_database.

AtlasEntityWithExtInfo

Uma instância de uma entidade juntamente com informações expandidas, como hive_table, hive_database.

AtlasErrorResponse

Uma resposta de erro do serviço

AtlasTermAssignmentHeader

O cabeçalho da atribuição de termos.

AtlasTermAssignmentStatus

Estado da atribuição de termos

EntityMutationResult

O resultado da resposta da mutação da entidade.

EntityStatus

Estado – pode ser ativo ou eliminado

TimeBoundary

Captura detalhes do limite de tempo

AtlasClassification

Uma instância de uma classificação; não tem uma identidade, este objeto só existe quando associado a uma entidade.

Name Tipo Description
attributes

Os atributos da estrutura.

entityGuid

string

O GUID da entidade.

entityStatus

EntityStatus

Estado da entidade – pode ser ativo ou eliminado. As entidades eliminadas não são removidas.

lastModifiedTS

string

ETag para controlo de simultaneidade.

removePropagationsOnEntityDelete

boolean

Determina se as propagações serão removidas na eliminação de entidades.

typeName

string

O nome do tipo.

validityPeriods

TimeBoundary[]

Uma matriz de limites de tempo que indicam períodos de validade.

AtlasEntity

Uma instância de uma entidade , como hive_table, hive_database.

Name Tipo Description
attributes

Os atributos da estrutura.

businessAttributes

Atributos empresariais

classifications

AtlasClassification[]

Uma matriz de classificações.

collectionId

string

O ID da coleção da entidade.

contacts

object

O dicionário de contactos para entidades. A chave pode ser Especialista ou Proprietário.

createTime

integer

A hora de criação do registo.

createdBy

string

O utilizador que criou o registo.

customAttributes

object

Atributo Personalizado

guid

string

O GUID da entidade.

homeId

string

O ID inicial da entidade.

isIncomplete

boolean

Se é uma entidade shell

labels

string[]

etiquetas

lastModifiedTS

string

ETag para controlo de simultaneidade.

meanings

AtlasTermAssignmentHeader[]

Uma matriz de cabeçalhos de atribuição de termos que indicam os significados da entidade.

provenanceType

integer

Utilizado para registar a proveniência de uma instância de uma entidade ou relação.

proxy

boolean

Determina se existe um proxy.

relationshipAttributes

Os atributos da relação.

status

EntityStatus

Estado da entidade – pode ser ativo ou eliminado. As entidades eliminadas não são removidas.

typeName

string

O nome do tipo.

updateTime

integer

A hora de atualização do registo.

updatedBy

string

O utilizador que atualizou o registo.

version

integer

A versão da entidade.

AtlasEntityHeader

Uma instância de uma entidade , como hive_table, hive_database.

Name Tipo Description
attributes

Os atributos da estrutura.

classificationNames

string[]

Uma matriz de nomes de classificação.

classifications

AtlasClassification[]

Uma matriz de classificações.

displayText

string

O texto a apresentar.

guid

string

O GUID do registo.

isIncomplete

boolean

Se é uma entidade shell

labels

string[]

etiquetas

lastModifiedTS

string

ETag para controlo de simultaneidade.

meaningNames

string[]

Uma matriz de significados.

meanings

AtlasTermAssignmentHeader[]

Uma matriz de cabeçalhos de atribuição de termos.

status

EntityStatus

Estado da entidade – pode ser ativo ou eliminado. As entidades eliminadas não são removidas.

typeName

string

O nome do tipo.

AtlasEntityWithExtInfo

Uma instância de uma entidade juntamente com informações expandidas, como hive_table, hive_database.

Name Tipo Description
entity

AtlasEntity

Uma instância de uma entidade , como hive_table, hive_database.

referredEntities

<string,  AtlasEntity>

As entidades referidas.

AtlasErrorResponse

Uma resposta de erro do serviço

Name Tipo Description
errorCode

string

O código de erro.

errorMessage

string

A mensagem de erro.

requestId

string

O ID do pedido.

AtlasTermAssignmentHeader

O cabeçalho da atribuição de termos.

Name Tipo Description
confidence

integer

A confiança da atribuição de termos.

createdBy

string

O utilizador que criou o registo.

description

string

A descrição do termo atribuição.

displayText

string

O texto a apresentar.

expression

string

A expressão do termo atribuição.

relationGuid

string

O GUID da relação.

status

AtlasTermAssignmentStatus

O estado da atribuição de termos.

steward

string

O administrador do termo.

termGuid

string

O GUID do termo.

AtlasTermAssignmentStatus

Estado da atribuição de termos

Name Tipo Description
DEPRECATED

string

O estado foi preterido.

DISCOVERED

string

O estado é detetado.

IMPORTED

string

O estado é importado.

OBSOLETE

string

O estado é obsoleto.

OTHER

string

Outro estado.

PROPOSED

string

O estado é proposto.

VALIDATED

string

O estado é validado.

EntityMutationResult

O resultado da resposta da mutação da entidade.

Name Tipo Description
guidAssignments

object

Um mapa de atribuições GUID com entidades.

mutatedEntities

object

Os cabeçalhos de entidade de entidades com mutação.

partialUpdatedEntities

AtlasEntityHeader[]

Uma matriz de cabeçalhos de entidade que foram parcialmente atualizados.

EntityStatus

Estado – pode ser ativo ou eliminado

Name Tipo Description
ACTIVE

string

O estado está ativo.

DELETED

string

O estado é eliminado.

TimeBoundary

Captura detalhes do limite de tempo

Name Tipo Description
endTime

string

O fim do limite de tempo.

startTime

string

O início do limite de tempo.

timeZone

string

O fuso horário do limite de tempo.