Lineage - Get By Unique Attribute

Serviço:

Purview

Versão da API:

2023-09-01

Retornar informações de linhagem sobre a entidade.

Além do parâmetro typeName path, pares chave-valor de atributo podem ser fornecidos no formato a seguir

attr:[attrName]=[attrValue]

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/lineage/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

GET {endpoint}/datamap/api/atlas/v2/lineage/uniqueAttribute/type/{typeName}?direction={direction}

Com parâmetros opcionais:

GET {endpoint}/datamap/api/atlas/v2/lineage/uniqueAttribute/type/{typeName}?depth={depth}&direction={direction}&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.
direction	query	True	LineageDirection	A direção da linhagem, que pode ser INPUT, OUTPUT ou BOTH.
attr:qualifiedName	query		string	O nome qualificado da entidade. (Este é apenas um exemplo. qualifiedName pode ser alterado para outros atributos exclusivos)
depth	query		integer int32	O número de saltos para linhagem.

Respostas

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

Lineage_GetByUniqueAttribute

Solicitação de exemplo

HTTP

GET {endpoint}/datamap/api/atlas/v2/lineage/uniqueAttribute/type/azure_blob_path?depth=2&direction=BOTH&attr:qualifiedName=https://02cab97b-ba87-4675-972d-150b6cb522d3/entity.json/

Resposta de exemplo

Código de status:

200

{
  "baseEntityGuid": "9b2751f1-2633-4f06-a578-e14fab4c52fd",
  "lineageDirection": "BOTH",
  "lineageDepth": 2,
  "lineageWidth": 2,
  "childrenCount": -1,
  "guidEntityMap": {
    "9b2751f1-2633-4f06-a578-e14fab4c52fd": {
      "typeName": "azure_blob_path",
      "attributes": {
        "owner": "testOwner",
        "modifiedTime": 0,
        "qualifiedName": "https://02cab97b-ba87-4675-972d-150b6cb522d3/entity.json/",
        "isBlob": false,
        "accessTierInferred": false,
        "description": "testDesc",
        "committedBlockCount": 0,
        "path": "/test/AzureBlobPath.json",
        "size": 731,
        "createTime": 0,
        "name": "populate_azure_blob_path_02cab97b-ba87-4675-972d-150b6cb522d3",
        "blobType": "BlockBlob",
        "serverEncrypted": true
      },
      "lastModifiedTS": "1",
      "guid": "9b2751f1-2633-4f06-a578-e14fab4c52fd",
      "status": "ACTIVE",
      "displayText": "populate_azure_blob_path_02cab97b-ba87-4675-972d-150b6cb522d3",
      "classificationNames": [
        "MICROSOFT.PERSONAL.EMAIL",
        "MICROSOFT.PERSONAL.NAME"
      ],
      "meaningNames": [],
      "meanings": [],
      "isIncomplete": false,
      "labels": []
    }
  },
  "relations": [],
  "parentRelations": [],
  "widthCounts": {
    "INPUT": {
      "9b2751f1-2633-4f06-a578-e14fab4c52fd": 0
    },
    "OUTPUT": {
      "9b2751f1-2633-4f06-a578-e14fab4c52fd": 0
    }
  }
}

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.
AtlasEntityHeader	Uma instância de uma entidade , como hive_table, hive_database.
AtlasErrorResponse	Uma resposta de erro do serviço
AtlasLineageInfo	As informações de linhagem.
AtlasTermAssignmentHeader	O cabeçalho da atribuição de termo.
AtlasTermAssignmentStatus	Status da atribuição de termo
EntityStatus	Status – pode ser ativo ou excluído
LineageDirection	Direção da linhagem
LineageRelation	A relação de linhagem com GUID da entidade from e to.
ParentRelation	A relação de pais de linhagem com o GUID da entidade pai e com a entidade filho.
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.

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

AtlasLineageInfo

As informações de linhagem.

Nome	Tipo	Description
baseEntityGuid	string	O GUID da entidade base.
childrenCount	integer	O número de nós filhos.
guidEntityMap	<string,  AtlasEntityHeader>	O mapa de entidades GUID.
lineageDepth	integer	A profundidade da linhagem.
lineageDirection	LineageDirection	A enumeração da direção da linhagem.
lineageWidth	integer	A largura da linhagem.
parentRelations	ParentRelation[]	Uma matriz de relações parentRelations.
relations	LineageRelation[]	Uma matriz de relações de linhagem.
widthCounts	object	A contagem de entidades em direção específica.

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.

LineageDirection

Direção da linhagem

Nome	Tipo	Description
BOTH	string	ambos
INPUT	string	input
OUTPUT	string	output

LineageRelation

A relação de linhagem com GUID da entidade from e to.

Nome	Tipo	Description
fromEntityId	string	O GUID da entidade.
relationshipId	string	O GUID da relação.
toEntityId	string	O GUID de para entidade.

ParentRelation

A relação de pais de linhagem com o GUID da entidade pai e com a entidade filho.

Nome	Tipo	Description
childEntityId	string	O GUID da entidade filho.
parentEntityId	string	O GUID da entidade pai.
relationshipId	string	O GUID da relação.

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.