Lineage - Get

Riferimento

Servizio:: Purview

Versione API:: 2023-09-01

Ottenere informazioni di derivazione dell'entità specificata dal GUID.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string
guid	path	True	string	Identificatore univoco globale dell'entità.
direction	query	True	LineageDirection	Direzione della derivazione, che può essere INPUT, OUTPUT o ENTRAMBI.
depth	query		integer int32	Numero di hop per la derivazione.

Risposte

Nome	Tipo	Descrizione
200 OK	AtlasLineageInfo	La richiesta ha avuto esito positivo.
Other Status Codes	AtlasErrorResponse	Risposta di errore imprevista.

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://purview.azure.net/.default

Esempio

Lineage_Get

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 200

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

Definizioni

Nome	Descrizione
AtlasClassification	Istanza di una classificazione; non ha un'identità, questo oggetto esiste solo quando associato a un'entità.
AtlasEntityHeader	Istanza di un'entità, ad esempio hive_table, hive_database.
AtlasErrorResponse	Risposta di errore dal servizio
AtlasLineageInfo	Informazioni sulla derivazione.
AtlasTermAssignmentHeader	Intestazione per l'assegnazione di termini.
AtlasTermAssignmentStatus	Stato per l'assegnazione di termini
EntityStatus	Stato : può essere attivo o eliminato
LineageDirection	Direzione di derivazione
LineageRelation	Relazione di derivazione con GUID dell'entità da e all'entità.
ParentRelation	Relazione padre di derivazione con GUID dell'entità padre e dell'entità figlio.
TimeBoundary	Acquisisce i dettagli del limite temporale

AtlasClassification

Istanza di una classificazione; non ha un'identità, questo oggetto esiste solo quando associato a un'entità.

Nome	Tipo	Descrizione
attributes		Attributi dello struct.
entityGuid	string	GUID dell'entità.
entityStatus	EntityStatus	Stato dell'entità: può essere attivo o eliminato. Le entità eliminate non vengono rimosse.
lastModifiedTS	string	ETag per il controllo di concorrenza.
removePropagationsOnEntityDelete	boolean	Determina se le propagazioni verranno rimosse per l'eliminazione dell'entità.
typeName	string	Nome del tipo.
validityPeriods	TimeBoundary[]	Matrice di limiti temporali che indicano periodi di validità.

AtlasEntityHeader

Istanza di un'entità, ad esempio hive_table, hive_database.

Nome	Tipo	Descrizione
attributes		Attributi dello struct.
classificationNames	string[]	Matrice di nomi di classificazione.
classifications	AtlasClassification[]	Matrice di classificazioni.
displayText	string	Testo visualizzato.
guid	string	GUID del record.
isIncomplete	boolean	Se si tratta di un'entità shell
labels	string[]	Etichette
lastModifiedTS	string	ETag per il controllo di concorrenza.
meaningNames	string[]	Matrice di significati.
meanings	AtlasTermAssignmentHeader[]	Matrice di intestazioni di assegnazione di termini.
status	EntityStatus	Stato dell'entità: può essere attivo o eliminato. Le entità eliminate non vengono rimosse.
typeName	string	Nome del tipo.

AtlasErrorResponse

Risposta di errore dal servizio

Nome	Tipo	Descrizione
errorCode	string	Codice di errore.
errorMessage	string	Messaggio di errore.
requestId	string	ID richiesta.

AtlasLineageInfo

Informazioni sulla derivazione.

Nome	Tipo	Descrizione
baseEntityGuid	string	GUID dell'entità di base.
childrenCount	integer	Numero di nodi figlio.
guidEntityMap	<string, AtlasEntityHeader>	Mappa dell'entità GUID.
lineageDepth	integer	Profondità di derivazione.
lineageDirection	LineageDirection	Enumerazione della direzione di derivazione.
lineageWidth	integer	Larghezza della derivazione.
parentRelations	ParentRelation[]	Matrice di relazioni padreRelations.
relations	LineageRelation[]	Matrice di relazioni di derivazione.
widthCounts	object	Numero di entità in direzione specifica.

AtlasTermAssignmentHeader

Intestazione per l'assegnazione di termini.

Nome	Tipo	Descrizione
confidence	integer	Attendibilità dell'assegnazione del termine.
createdBy	string	Utente che ha creato il record.
description	string	Descrizione dell'assegnazione del termine.
displayText	string	Testo visualizzato.
expression	string	Espressione dell'assegnazione del termine.
relationGuid	string	GUID della relazione.
status	AtlasTermAssignmentStatus	Stato dell'assegnazione dei termini.
steward	string	Il responsabile del termine.
termGuid	string	GUID del termine.

AtlasTermAssignmentStatus

Stato per l'assegnazione di termini

Nome	Tipo	Descrizione
DEPRECATED	string	Lo stato è deprecato.
DISCOVERED	string	Lo stato viene individuato.
IMPORTED	string	Lo stato viene importato.
OBSOLETE	string	Lo stato è obsoleto.
OTHER	string	Altro stato.
PROPOSED	string	Lo stato viene proposto.
VALIDATED	string	Lo stato viene convalidato.

EntityStatus

Stato : può essere attivo o eliminato

Nome	Tipo	Descrizione
ACTIVE	string	Lo stato è attivo.
DELETED	string	Lo stato viene eliminato.

LineageDirection

Direzione di derivazione

Nome	Tipo	Descrizione
BOTH	string	Entrambi
INPUT	string	input
OUTPUT	string	output

LineageRelation

Relazione di derivazione con GUID dell'entità da e all'entità.

Nome	Tipo	Descrizione
fromEntityId	string	GUID di from-entity.
relationshipId	string	GUID della relazione.
toEntityId	string	GUID dell'entità da entità a.

ParentRelation

Relazione padre di derivazione con GUID dell'entità padre e dell'entità figlio.

Nome	Tipo	Descrizione
childEntityId	string	GUID dell'entità figlio.
parentEntityId	string	GUID dell'entità padre.
relationshipId	string	GUID della relazione.

TimeBoundary

Acquisisce i dettagli del limite temporale

Nome	Tipo	Descrizione
endTime	string	Fine del limite di tempo.
startTime	string	Inizio del limite di tempo.
timeZone	string	Fuso orario del limite di tempo.

Condividi tramite