Lineage - Get

Service:

Purview

Version d'API:

2023-09-01

Obtenez les informations de traçabilité de l’entité spécifiée par LE GUID.

GET {endpoint}/datamap/api/atlas/v2/lineage/{guid}?direction={direction}

Avec des paramètres facultatifs:

GET {endpoint}/datamap/api/atlas/v2/lineage/{guid}?depth={depth}&direction={direction}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string
guid	path	True	string	Identificateur global unique de l’entité.
direction	query	True	LineageDirection	Direction de la traçabilité, qui peut être ENTRÉE, OUTPUT ou BOTH.
depth	query		integer int32	Nombre de tronçons pour la traçabilité.

Réponses

Nom	Type	Description
200 OK	AtlasLineageInfo	La demande a réussi.
Other Status Codes	AtlasErrorResponse	Réponse d’erreur inattendue.

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

Lineage_Get

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

200

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

Définitions

Nom	Description
AtlasClassification	Un instance d’une classification ; il n’a pas d’identité, cet objet existe uniquement lorsqu’il est associé à une entité.
AtlasEntityHeader	Instance d’une entité, comme hive_table, hive_database.
AtlasErrorResponse	Réponse d’erreur du service
AtlasLineageInfo	Informations de traçabilité.
AtlasTermAssignmentHeader	En-tête de l’attribution de terme.
AtlasTermAssignmentStatus	État de l’attribution de terme
EntityStatus	État : peut être actif ou supprimé
LineageDirection	Direction de la traçabilité
LineageRelation	Relation de traçabilité avec le GUID de l’entité de et vers.
ParentRelation	Relation des parents de traçabilité avec le GUID de l’entité parente et avec l’entité enfant.
TimeBoundary	Capture les détails de la limite de temps

AtlasClassification

Un instance d’une classification ; il n’a pas d’identité, cet objet existe uniquement lorsqu’il est associé à une entité.

Nom	Type	Description
attributes		Attributs du struct.
entityGuid	string	GUID de l’entité.
entityStatus	EntityStatus	État de l’entité : peut être actif ou supprimé. Les entités supprimées ne sont pas supprimées.
lastModifiedTS	string	ETag pour le contrôle d’accès concurrentiel.
removePropagationsOnEntityDelete	boolean	Détermine si les propagations seront supprimées lors de la suppression d’entité.
typeName	string	Nom du type.
validityPeriods	TimeBoundary[]	Tableau de limites de temps indiquant des périodes de validité.

AtlasEntityHeader

Instance d’une entité, comme hive_table, hive_database.

Nom	Type	Description
attributes		Attributs du struct.
classificationNames	string[]	Tableau de noms de classification.
classifications	AtlasClassification[]	Tableau de classifications.
displayText	string	Texte d’affichage.
guid	string	GUID de l’enregistrement.
isIncomplete	boolean	S’il s’agit d’une entité shell
labels	string[]	étiquettes
lastModifiedTS	string	ETag pour le contrôle d’accès concurrentiel.
meaningNames	string[]	Tableau de significations.
meanings	AtlasTermAssignmentHeader[]	Tableau d’en-têtes d’affectation de terme.
status	EntityStatus	État de l’entité : peut être actif ou supprimé. Les entités supprimées ne sont pas supprimées.
typeName	string	Nom du type.

AtlasErrorResponse

Réponse d’erreur du service

Nom	Type	Description
errorCode	string	Code d'erreur.
errorMessage	string	Message d’erreur.
requestId	string	ID de demande.

AtlasLineageInfo

Informations de traçabilité.

Nom	Type	Description
baseEntityGuid	string	GUID de l’entité de base.
childrenCount	integer	Nombre de nœuds enfants.
guidEntityMap	<string,  AtlasEntityHeader>	Mappage d’entités GUID.
lineageDepth	integer	Profondeur de la traçabilité.
lineageDirection	LineageDirection	Énumération du sens de traçabilité.
lineageWidth	integer	Largeur de la traçabilité.
parentRelations	ParentRelation[]	Tableau de relations parentRelations.
relations	LineageRelation[]	Tableau de relations de traçabilité.
widthCounts	object	Nombre d’entités dans une direction spécifique.

AtlasTermAssignmentHeader

En-tête de l’attribution de terme.

Nom	Type	Description
confidence	integer	Confiance de l’affectation de terme.
createdBy	string	Utilisateur qui a créé l’enregistrement.
description	string	Description de l’affectation de terme.
displayText	string	Texte d’affichage.
expression	string	Expression de l’affectation de terme.
relationGuid	string	GUID de la relation.
status	AtlasTermAssignmentStatus	Status de l’attribution de termes.
steward	string	Intendant du terme.
termGuid	string	GUID du terme.

AtlasTermAssignmentStatus

État de l’attribution de terme

Nom	Type	Description
DEPRECATED	string	Le status est déconseillé.
DISCOVERED	string	Le status est découvert.
IMPORTED	string	Le status est importé.
OBSOLETE	string	Le status est obsolète.
OTHER	string	Autres status.
PROPOSED	string	Le status est proposé.
VALIDATED	string	Le status est validé.

EntityStatus

État : peut être actif ou supprimé

Nom	Type	Description
ACTIVE	string	Le status est actif.
DELETED	string	Le status est supprimé.

LineageDirection

Direction de la traçabilité

Nom	Type	Description
BOTH	string	Les deux
INPUT	string	entrée
OUTPUT	string	sortie

LineageRelation

Relation de traçabilité avec le GUID de l’entité de et vers.

Nom	Type	Description
fromEntityId	string	GUID de from-entity.
relationshipId	string	GUID de la relation.
toEntityId	string	GUID de to-entity.

ParentRelation

Relation des parents de traçabilité avec le GUID de l’entité parente et avec l’entité enfant.

Nom	Type	Description
childEntityId	string	GUID de l’entité enfant.
parentEntityId	string	GUID de l’entité parente.
relationshipId	string	GUID de la relation.

TimeBoundary

Capture les détails de la limite de temps

Nom	Type	Description
endTime	string	Fin de la limite de temps.
startTime	string	Début de la limite de temps.
timeZone	string	Fuseau horaire de la limite de temps.