Entity - Partial Update Attribute By Guid

Referência

Serviço:: Purview

Versão da API:: 2023-09-01

Atualizar a entidade parcialmente – criar ou atualizar o atributo de entidade identificado por seu GUID. Dá suporte apenas a referências de entidade e tipo de atributo primitivo. Ele não dá suporte à atualização de tipos complexos, como matrizes e mapas. Atualizações nulas não são possíveis.

PUT {endpoint}/datamap/api/atlas/v2/entity/guid/{guid}?name={name}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string
guid	path	True	string	O identificador global exclusivo da entidade.
name	query	True	string	O nome do atributo.

Respostas

Nome	Tipo	Description
200 OK	EntityMutationResult	A solicitação foi bem-sucedida.
Other Status Codes	AtlasErrorResponse	Uma resposta de erro inesperada.

Segurança

OAuth2Auth

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

Escopos

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

Exemplos

Entity_PartialUpdateAttributeByGuid

Solicitação de exemplo

HTTP

PUT {endpoint}/datamap/api/atlas/v2/entity/guid/394d9a03-912e-483b-bbd2-bedee1a69798?name=ExampleName

"ExampleNewName"

Resposta de exemplo

Código de status:: 200

{
  "mutatedEntities": {
    "CREATE": [
      {
        "typeName": "azure_storage_account",
        "attributes": {
          "qualifiedName": "https://exampleaccount.core.windows.net"
        },
        "lastModifiedTS": "1",
        "guid": "394d9a03-912e-483b-bbd2-bedee1a69798",
        "status": "ACTIVE"
      }
    ]
  },
  "partialUpdatedEntities": [
    {
      "typeName": "azure_storage_account",
      "attributes": {
        "qualifiedName": "https://exampleaccount.core.windows.net"
      },
      "lastModifiedTS": "1",
      "guid": "394d9a03-912e-483b-bbd2-bedee1a69798"
    }
  ]
}

Definições

Nome	Description
AtlasClassification	Uma instância de uma classificação; ele não tem uma identidade, esse objeto só existe quando associado a uma entidade.
AtlasEntityHeader	Uma instância de uma entidade , como hive_table, hive_database.
AtlasErrorResponse	Uma resposta de erro do serviço
AtlasTermAssignmentHeader	O cabeçalho para atribuição de termo.
AtlasTermAssignmentStatus	Status da atribuição de termos
EntityMutationResult	O resultado da resposta de mutação da entidade.
EntityStatus	Status – pode ser ativo ou excluído
TimeBoundary	Captura detalhes de limite de tempo

AtlasClassification

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

Nome	Tipo	Description
attributes		Os atributos do struct.
entityGuid	string	O GUID da entidade.
entityStatus	EntityStatus	Status da entidade – pode estar ativo ou excluído. Entidades excluídas não são removidas.
lastModifiedTS	string	ETag para controle de simultaneidade.
removePropagationsOnEntityDelete	boolean	Determina se as propagações serão removidas na exclusão de entidade.
typeName	string	O nome do tipo.
validityPeriods	TimeBoundary[]	Uma matriz de limites de tempo que indica períodos de validade.

AtlasEntityHeader

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

Nome	Tipo	Description
attributes		Os atributos do struct.
classificationNames	string[]	Uma matriz de nomes de classificação.
classifications	AtlasClassification[]	Uma matriz de classificações.
displayText	string	O texto de exibição.
guid	string	O GUID do registro.
isIncomplete	boolean	Se é uma entidade de shell
labels	string[]	rótulos
lastModifiedTS	string	ETag para controle de simultaneidade.
meaningNames	string[]	Uma matriz de significados.
meanings	AtlasTermAssignmentHeader[]	Uma matriz de cabeçalhos de atribuição de termos.
status	EntityStatus	Status da entidade – pode estar ativo ou excluído. Entidades excluídas não são removidas.
typeName	string	O nome do tipo.

AtlasErrorResponse

Uma resposta de erro do serviço

Nome	Tipo	Description
errorCode	string	O código de erro.
errorMessage	string	A mensagem de erro.
requestId	string	A ID da solicitação.

AtlasTermAssignmentHeader

O cabeçalho para atribuição de termo.

Nome	Tipo	Description
confidence	integer	A confiança do termo atribuição.
createdBy	string	O usuário que criou o registro.
description	string	A descrição do termo atribuição.
displayText	string	O texto de exibição.
expression	string	A expressão do termo atribuição.
relationGuid	string	O GUID da relação.
status	AtlasTermAssignmentStatus	O status de atribuição de termos.
steward	string	O administrador do termo.
termGuid	string	O GUID do termo.

AtlasTermAssignmentStatus

Status da atribuição de termos

Nome	Tipo	Description
DEPRECATED	string	O status foi preterido.
DISCOVERED	string	O status foi descoberto.
IMPORTED	string	O status é importado.
OBSOLETE	string	O status está obsoleto.
OTHER	string	Outros status.
PROPOSED	string	O status é proposto.
VALIDATED	string	O status é validado.

EntityMutationResult

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

Nome	Tipo	Description
guidAssignments	object	Um mapa de atribuições de GUID com entidades.
mutatedEntities	object	Os cabeçalhos de entidade de entidades mutadas.
partialUpdatedEntities	AtlasEntityHeader[]	Uma matriz de cabeçalhos de entidade que foram parcialmente atualizados.

EntityStatus

Status – pode ser ativo ou excluído

Nome	Tipo	Description
ACTIVE	string	O status está ativo.
DELETED	string	O status é excluído.

TimeBoundary

Captura detalhes de limite de tempo

Nome	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.

Compartilhar via