Entity - Get By Unique Attributes

Referência

Serviço:: Purview

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

Obtenha a definição completa de uma entidade, considerando seu tipo e atributo exclusivo.

Além do parâmetro typeName path, o atributo key-value pair(s) pode ser fornecido no seguinte formato: attr:<attrName>=.

OBSERVAÇÃO: o attrName e o attrValue devem ser exclusivos entre entidades, por exemplo. Qualifiedname.

A solicitação REST seria semelhante a esta: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}

Com parâmetros opcionais:

GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}?minExtInfo={minExtInfo}&ignoreRelationships={ignoreRelationships}&attr:qualifiedName={attr:qualifiedName}

Parâmetros de URI

Nome	Em	Obrigató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)
ignoreRelationships	query		boolean	Se os atributos de relação devem ser ignorados.
minExtInfo	query		boolean	Se deve retornar informações mínimas para entidades referenciadas.

Respostas

Nome	Tipo	Description
200 OK	AtlasEntityWithExtInfo	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_GetByUniqueAttributes

Solicitação de exemplo

HTTP

GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/azure_storage_account?minExtInfo=True&attr:qualifiedName=https://exampleaccount.core.windows.net

Resposta de exemplo

Código de status:: 200

{
  "entity": {
    "createTime": 1605703532110,
    "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
    "guid": "e0ba3f20-f3b5-4d52-b769-ed35a02df60a",
    "relationshipAttributes": {
      "services": [],
      "meanings": []
    },
    "status": "ACTIVE",
    "updateTime": 1605703532110,
    "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
    "lastModifiedTS": "2",
    "version": 0,
    "attributes": {
      "owner": "ExampleOwner",
      "qualifiedName": "https://exampleaccount.core.windows.net",
      "createTime": 0,
      "name": "ExampleNewName"
    },
    "typeName": "azure_storage_account"
  },
  "referredEntities": {}
}

Definições

Nome	Description
AtlasClassification	Uma instância de uma classificação; ele não tem uma identidade, esse objeto existe somente quando associado a uma entidade.
AtlasEntity	Uma instância de uma entidade , como hive_table, hive_database.
AtlasEntityWithExtInfo	Uma instância de uma entidade juntamente com informações estendidas, como hive_table, hive_database.
AtlasErrorResponse	Uma resposta de erro do serviço
AtlasTermAssignmentHeader	O cabeçalho da atribuição de termo.
AtlasTermAssignmentStatus	Status da atribuição de termo
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 existe somente 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 da entidade.
typeName	string	O nome do tipo.
validityPeriods	TimeBoundary[]	Uma matriz de limites de tempo que indica períodos de validade.

AtlasEntity

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

Nome	Tipo	Description
attributes		Os atributos do struct.
businessAttributes		Atributos de negócios
classifications	AtlasClassification[]	Uma matriz de classificações.
collectionId	string	A ID da coleção da entidade.
contacts	object	O dicionário de contatos para entidades. A chave pode ser Especialista ou Proprietário.
createTime	integer	A hora criada do registro.
createdBy	string	O usuário que criou o registro.
customAttributes	object	Atributo Personalizado
guid	string	O GUID da entidade.
homeId	string	A ID inicial da entidade.
isIncomplete	boolean	Se é uma entidade de shell
labels	string[]	rótulos
lastModifiedTS	string	ETag para controle de simultaneidade.
meanings	AtlasTermAssignmentHeader[]	Uma matriz de cabeçalhos de atribuição de termo que indica os significados da entidade.
provenanceType	integer	Usado para registrar a procedência de uma instância de uma entidade ou relação.
proxy	boolean	Determina se há um proxy.
relationshipAttributes		Os atributos da relação.
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.
updateTime	integer	O tempo de atualização do registro.
updatedBy	string	O usuário que atualizou o registro.
version	integer	A versão da entidade.

AtlasEntityWithExtInfo

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

Nome	Tipo	Description
entity	AtlasEntity	Uma instância de uma entidade , como hive_table, hive_database.
referredEntities	<string, AtlasEntity>	As entidades referenciadas.

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 da 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 termo

Nome	Tipo	Description
DEPRECATED	string	O status foi preterido.
DISCOVERED	string	O status é 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.

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.