Freigeben über

Lineage - Get

Dienst:
Purview
API-Version:
2023-09-01

Abrufen von Zeileninformationen der durch GUID angegebenen Entität.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
 path True

string (uri)

guid
 path True

string

Der global eindeutige Bezeichner der Entität.
direction
 query True

LineageDirection

Die Richtung der Linie, die INPUT, OUTPUT oder BOTH sein kann.
depth
 query

integer (int32)

Die Anzahl der Hops für Die Linien.

Antworten

Name Typ Beschreibung
200 OK

AtlasLineageInfo

Die Anforderung ist erfolgreich.
Other Status Codes

AtlasErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
https://purview.azure.net/.default

Beispiele

Lineage_Get

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
AtlasClassification

Eine Instanz einer Klassifizierung; es hat keine Identität, dieses Objekt ist nur vorhanden, wenn es einer Entität zugeordnet ist.
AtlasEntityHeader

Eine Instanz einer Entität , z. B. hive_table, hive_database.
AtlasErrorResponse

Eine Fehlerantwort des Diensts
AtlasLineageInfo

Die Zeileninformationen.
AtlasTermAssignmentHeader

Der Header für die Ausdruckszuweisung.
AtlasTermAssignmentStatus

Status für Die Begriffszuweisung
EntityStatus

Status – kann aktiv oder gelöscht werden
LineageDirection

Linienrichtung
LineageRelation

Die Linienbeziehung mit der GUID des Typs "Von" und "Entität".
ParentRelation

Die Beziehung zwischen den übergeordneten Elementen und der GUID der übergeordneten Entität und der untergeordneten Entität.
TimeBoundary

Erfasst Zeitbegrenzungsdetails

AtlasClassification

Objekt

Eine Instanz einer Klassifizierung; es hat keine Identität, dieses Objekt ist nur vorhanden, wenn es einer Entität zugeordnet ist.

Name Typ Beschreibung
attributes

Die Attribute der Struktur.
entityGuid

string

Die GUID der Entität.
entityStatus

EntityStatus

Status der Entität – kann aktiv oder gelöscht werden. Gelöschte Entitäten werden nicht entfernt.
lastModifiedTS

string

ETag für Parallelitätssteuerelement.
removePropagationsOnEntityDelete

boolean

Bestimmt, ob Verteilungen beim Löschen der Entität entfernt werden.
typeName

string

Der Name des Typs.
validityPeriods

TimeBoundary[]

Ein Array von Zeitgrenzen, das gültigkeitsperioden angibt.

AtlasEntityHeader

Objekt

Eine Instanz einer Entität , z. B. hive_table, hive_database.

Name Typ Beschreibung
attributes

Die Attribute der Struktur.
classificationNames

string[]

Ein Array von Klassifizierungsnamen.
classifications

AtlasClassification[]

Ein Array von Klassifizierungen.
displayText

string

Der Anzeigetext.
guid

string

Die GUID des Datensatzes.
isIncomplete

boolean

Gibt an, ob es sich um eine Shellentität handelt.
labels

string[]

etiketten
lastModifiedTS

string

ETag für Parallelitätssteuerelement.
meaningNames

string[]

Ein Array von Bedeutungen.
meanings

AtlasTermAssignmentHeader[]

Ein Array von Ausdruckszuweisungsheadern.
status

EntityStatus

Status der Entität – kann aktiv oder gelöscht werden. Gelöschte Entitäten werden nicht entfernt.
typeName

string

Der Name des Typs.

AtlasErrorResponse

Objekt

Eine Fehlerantwort des Diensts

Name Typ Beschreibung
errorCode

string

Der Fehlercode.
errorMessage

string

Die Fehlermeldung.
requestId

string (uuid)

Die Anforderungs-ID.

AtlasLineageInfo

Objekt

Die Zeileninformationen.

Name Typ Beschreibung
baseEntityGuid

string

Die GUID der Basisentität.
childrenCount

integer (int32)

Die Anzahl der untergeordneten Knoten.
guidEntityMap

<string,  AtlasEntityHeader>

Die GUID-Entitätszuordnung.
lineageDepth

integer (int32)

Die Tiefe der Linien.
lineageDirection

LineageDirection

Die Enumeration der Linienrichtung.
lineageWidth

integer (int32)

Die Breite der Linie.
parentRelations

ParentRelation[]

Ein Array von parentRelations-Beziehungen.
relations

LineageRelation[]

Ein Array von Linienbeziehungen.
widthCounts

object

Die Entitätsanzahl in einer bestimmten Richtung.

AtlasTermAssignmentHeader

Objekt

Der Header für die Ausdruckszuweisung.

Name Typ Beschreibung
confidence

integer (int32)

Die Konfidenz der Begriffszuweisung.
createdBy

string

Der Benutzer, der den Datensatz erstellt hat.
description

string

Die Beschreibung der Begriffszuweisung.
displayText

string

Der Anzeigetext.
expression

string

Der Ausdruck der Ausdruckszuweisung.
relationGuid

string (uuid)

Die GUID der Beziehung.
status

AtlasTermAssignmentStatus

Der Status der Begriffszuweisung.
steward

string

Der Steward des Begriffs.
termGuid

string (uuid)

Die GUID des Ausdrucks.

AtlasTermAssignmentStatus

Enumeration

Status für Die Begriffszuweisung

Wert Beschreibung
DISCOVERED

Der Status wird ermittelt.
PROPOSED

Der Status wird vorgeschlagen.
IMPORTED

Der Status wird importiert.
VALIDATED

Der Status wird überprüft.
DEPRECATED

Der Status ist veraltet.
OBSOLETE

Der Status ist veraltet.
OTHER

Anderer Status.

EntityStatus

Enumeration

Status – kann aktiv oder gelöscht werden

Wert Beschreibung
ACTIVE

Der Status ist aktiv.
DELETED

Der Status wird gelöscht.

LineageDirection

Enumeration

Linienrichtung

Wert Beschreibung
INPUT

Eingabe
OUTPUT

output
BOTH

beides

LineageRelation

Objekt

Die Linienbeziehung mit der GUID des Typs "Von" und "Entität".

Name Typ Beschreibung
fromEntityId

string

Die GUID von der Entität.
relationshipId

string

Die GUID der Beziehung.
toEntityId

string

Die GUID der Zu-Entität.

ParentRelation

Objekt

Die Beziehung zwischen den übergeordneten Elementen und der GUID der übergeordneten Entität und der untergeordneten Entität.

Name Typ Beschreibung
childEntityId

string

Die GUID der untergeordneten Entität.
parentEntityId

string

Die GUID der übergeordneten Entität.
relationshipId

string

Die GUID der Beziehung.

TimeBoundary

Objekt

Erfasst Zeitbegrenzungsdetails

Name Typ Beschreibung
endTime

string

Das Ende der Zeitgrenze.
startTime

string

Der Anfang der Zeitgrenze.
timeZone

string

Die Zeitzone der Zeitgrenze.