Partager via

Lineage - Get

Service:
Purview
Version d'API:
2023-09-01

Obtenez les informations de traçabilité de l’entité spécifiée par 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 (uri)

guid
 path True

string

Identificateur global unique de l’entité.
direction
 query True

LineageDirection

Direction de la traçabilité, qui peut être INPUT, OUTPUT ou BOTH.
depth
 query

integer (int32)

Nombre de sauts 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

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

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’affectation de terme.
AtlasTermAssignmentStatus

État de l’affectation de terme
EntityStatus

État : peut être actif ou supprimé
LineageDirection

Direction de traçabilité
LineageRelation

Relation de traçabilité avec le GUID de l’entité de l’entité et de la provenance.
ParentRelation

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

Capture les détails des limites temporelles

AtlasClassification

Object

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 les périodes de validité.

AtlasEntityHeader

Object

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

Indique 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

Object

Réponse d’erreur du service

Nom Type Description
errorCode

string

Code d’erreur.
errorMessage

string

Message d’erreur.
requestId

string (uuid)

ID de demande.

AtlasLineageInfo

Object

Informations de traçabilité.

Nom Type Description
baseEntityGuid

string

GUID de l’entité de base.
childrenCount

integer (int32)

Nombre de nœuds enfants.
guidEntityMap

<string,  AtlasEntityHeader>

Mappage d’entité GUID.
lineageDepth

integer (int32)

Profondeur de traçabilité.
lineageDirection

LineageDirection

Énumération de direction de traçabilité.
lineageWidth

integer (int32)

Largeur de lignage.
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

Object

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

Nom Type Description
confidence

integer (int32)

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 (uuid)

GUID de la relation.
status

AtlasTermAssignmentStatus

État de l’affectation de termes.
steward

string

L’administrateur du terme.
termGuid

string (uuid)

GUID du terme.

AtlasTermAssignmentStatus

Énumération

État de l’affectation de terme

Valeur Description
DISCOVERED

L’état est découvert.
PROPOSED

Le statut est proposé.
IMPORTED

L’état est importé.
VALIDATED

L’état est validé.
DEPRECATED

L’état est déconseillé.
OBSOLETE

L’état est obsolète.
OTHER

Autre état.

EntityStatus

Énumération

État : peut être actif ou supprimé

Valeur Description
ACTIVE

L’état est actif.
DELETED

L’état est supprimé.

LineageDirection

Énumération

Direction de traçabilité

Valeur Description
INPUT

entrée
OUTPUT

sortie
BOTH

les deux

LineageRelation

Object

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

Nom Type Description
fromEntityId

string

GUID de l’entité à partir de l’entité.
relationshipId

string

GUID de la relation.
toEntityId

string

GUID de l’entité.

ParentRelation

Object

Relation des parents de traçabilité avec le GUID de l’entité parente et de 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

Object

Capture les détails des limites temporelles

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.