Compartir a través de

Lineage - Get

Servicio:
Purview
Versión de la API:
2023-09-01

Obtiene información de linaje de la entidad especificada por GUID.

GET {endpoint}/datamap/api/atlas/v2/lineage/{guid}?direction={direction}
Con parámetros opcionales: 
GET {endpoint}/datamap/api/atlas/v2/lineage/{guid}?depth={depth}&direction={direction}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
 path True

string (uri)

guid
 path True

string

Identificador único global de la entidad.
direction
 query True

LineageDirection

Dirección del linaje, que podría ser INPUT, OUTPUT o BOTH.
depth
 query

integer (int32)

Número de saltos para el linaje.

Respuestas

Nombre Tipo Description
200 OK

AtlasLineageInfo

La solicitud se ha realizado correctamente.
Other Status Codes

AtlasErrorResponse

Una respuesta de error inesperada.

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

Ejemplos

Lineage_Get

Solicitud de ejemplo

GET {endpoint}/datamap/api/atlas/v2/lineage/a6894eb3-81f3-829b-2adc-52f3e603411a?depth=1&direction=INPUT

Respuesta de muestra

status code:
200 
{
  "baseEntityGuid": "a6894eb3-81f3-829b-2adc-52f3e603411a",
  "lineageDirection": "INPUT",
  "lineageDepth": 1,
  "lineageWidth": 1,
  "childrenCount": 1,
  "guidEntityMap": {},
  "widthCounts": {},
  "relations": [],
  "parentRelations": []
}

Definiciones

Nombre Description
AtlasClassification

Una instancia de una clasificación; no tiene una identidad, este objeto solo existe cuando está asociado a una entidad.
AtlasEntityHeader

Instancia de una entidad, como hive_table, hive_database.
AtlasErrorResponse

Respuesta de error del servicio
AtlasLineageInfo

Información de linaje.
AtlasTermAssignmentHeader

Encabezado para la asignación de términos.
AtlasTermAssignmentStatus

Estado de la asignación de términos
EntityStatus

Estado: se puede activar o eliminar.
LineageDirection

Dirección del linaje
LineageRelation

Relación de linaje con el GUID de la entidad de y a .
ParentRelation

Relación de los elementos primarios de linaje con el GUID de la entidad primaria y la entidad secundaria.
TimeBoundary

Captura los detalles del límite de tiempo

AtlasClassification

Object

Una instancia de una clasificación; no tiene una identidad, este objeto solo existe cuando está asociado a una entidad.

Nombre Tipo Description
attributes

Atributos de la estructura.
entityGuid

string

GUID de la entidad.
entityStatus

EntityStatus

Estado de la entidad: se puede activar o eliminar. Las entidades eliminadas no se quitan.
lastModifiedTS

string

ETag para el control de simultaneidad.
removePropagationsOnEntityDelete

boolean

Determina si se quitarán las propagaciones en la eliminación de entidades.
typeName

string

Nombre del tipo.
validityPeriods

TimeBoundary[]

Matriz de límites de tiempo que indica períodos de validez.

AtlasEntityHeader

Object

Instancia de una entidad, como hive_table, hive_database.

Nombre Tipo Description
attributes

Atributos de la estructura.
classificationNames

string[]

Matriz de nombres de clasificación.
classifications

AtlasClassification[]

Matriz de clasificaciones.
displayText

string

Texto para mostrar.
guid

string

GUID del registro.
isIncomplete

boolean

Si es una entidad de shell
labels

string[]

Etiquetas
lastModifiedTS

string

ETag para el control de simultaneidad.
meaningNames

string[]

Matriz de significados.
meanings

AtlasTermAssignmentHeader[]

Matriz de encabezados de asignación de términos.
status

EntityStatus

Estado de la entidad: se puede activar o eliminar. Las entidades eliminadas no se quitan.
typeName

string

Nombre del tipo.

AtlasErrorResponse

Object

Respuesta de error del servicio

Nombre Tipo Description
errorCode

string

Código de error.
errorMessage

string

Mensaje de error.
requestId

string (uuid)

Identificador de solicitud.

AtlasLineageInfo

Object

Información de linaje.

Nombre Tipo Description
baseEntityGuid

string

GUID de la entidad base.
childrenCount

integer (int32)

Número de nodos secundarios.
guidEntityMap

<string,  AtlasEntityHeader>

Mapa de entidades GUID.
lineageDepth

integer (int32)

Profundidad del linaje.
lineageDirection

LineageDirection

Enumeración de la dirección del linaje.
lineageWidth

integer (int32)

Ancho del linaje.
parentRelations

ParentRelation[]

Matriz de relaciones parentRelations.
relations

LineageRelation[]

Matriz de relaciones de linaje.
widthCounts

object

Recuento de entidades en dirección específica.

AtlasTermAssignmentHeader

Object

Encabezado para la asignación de términos.

Nombre Tipo Description
confidence

integer (int32)

Confianza de la asignación de términos.
createdBy

string

Usuario que creó el registro.
description

string

Descripción de la asignación de términos.
displayText

string

Texto para mostrar.
expression

string

Expresión de la asignación de términos.
relationGuid

string (uuid)

GUID de la relación.
status

AtlasTermAssignmentStatus

Estado de la asignación de términos.
steward

string

El administrador del término.
termGuid

string (uuid)

GUID del término.

AtlasTermAssignmentStatus

Enumeración

Estado de la asignación de términos

Valor Description
DISCOVERED

El estado se detecta.
PROPOSED

Se propone el estado.
IMPORTED

El estado se importa.
VALIDATED

El estado se valida.
DEPRECATED

El estado está en desuso.
OBSOLETE

El estado está obsoleto.
OTHER

Otro estado.

EntityStatus

Enumeración

Estado: se puede activar o eliminar.

Valor Description
ACTIVE

El estado está activo.
DELETED

El estado se elimina.

LineageDirection

Enumeración

Dirección del linaje

Valor Description
INPUT

entrada
OUTPUT

salida
BOTH

ambos

LineageRelation

Object

Relación de linaje con el GUID de la entidad de y a .

Nombre Tipo Description
fromEntityId

string

GUID de from-entity.
relationshipId

string

GUID de la relación.
toEntityId

string

Guid de a entidad.

ParentRelation

Object

Relación de los elementos primarios de linaje con el GUID de la entidad primaria y la entidad secundaria.

Nombre Tipo Description
childEntityId

string

GUID de la entidad secundaria.
parentEntityId

string

GUID de la entidad primaria.
relationshipId

string

GUID de la relación.

TimeBoundary

Object

Captura los detalles del límite de tiempo

Nombre Tipo Description
endTime

string

Fin del límite de tiempo.
startTime

string

Inicio del límite de hora.
timeZone

string

Zona horaria del límite horario.