Relationship - Get

Referenz

Dienst:: Purview

API-Version:: 2023-09-01

Abrufen von Beziehungsinformationen zwischen Entitäten anhand der GUID.

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/{guid}

Mit optionalen Parametern:

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/{guid}?extendedInfo={extendedInfo}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string
guid	path	True	string	Der global eindeutige Bezeichner der Beziehung.
extendedInfo	query		boolean	Schränkt ein, ob erweiterte Informationen enthalten sind.

Antworten

Name	Typ	Beschreibung
200 OK	AtlasRelationshipWithExtInfo	Die Anforderung wurde erfolgreich durchgeführt.
Other Status Codes	AtlasErrorResponse	Eine 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

Relationship_Get

Beispielanforderung

HTTP

GET {endpoint}/datamap/api/atlas/v2/relationship/guid/5cf8a9e5-c9fd-abe0-2e8c-d40024263dcb?extendedInfo=false

Beispiel für eine Antwort

Statuscode:: 200

{
  "relationship": {
    "typeName": "AtlasGlossarySynonym",
    "attributes": {
      "expression": null,
      "steward": null,
      "description": null,
      "source": null,
      "status": null
    },
    "guid": "de23cd5a-021c-413d-98a5-98752a1f7a3b",
    "end1": {
      "guid": "856d31e6-e342-a1ce-6273-22ddb77029c6",
      "typeName": "AtlasGlossaryTerm"
    },
    "end2": {
      "guid": "b0942506-2d7d-1f45-d286-c29ca9e7f2ef",
      "typeName": "AtlasGlossaryTerm"
    },
    "label": "r:AtlasGlossarySynonym",
    "status": "ACTIVE",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "createTime": 1553838993803,
    "updateTime": 1553838993803,
    "version": 0
  }
}

Definitionen

Name	Beschreibung
AtlasClassification	Ein instance einer Klassifizierung. Es verfügt über keine Identität, dieses Objekt ist nur vorhanden, wenn es einer Entität zugeordnet ist.
AtlasEntityHeader	Ein instance einer Entität – z. B. hive_table, hive_database.
AtlasErrorResponse	Eine Fehlerantwort des Diensts
AtlasObjectId	Verweis auf ein objekt-instance eines Typs - wie Entität.
AtlasRelationship	Atlas-Beziehung instance.
AtlasRelationshipWithExtInfo	Die Beziehung zu erweiterten Informationen.
AtlasTermAssignmentHeader	Der Header für die Ausdruckszuweisung.
AtlasTermAssignmentStatus	Status für Begriffszuweisung
EntityStatus	Status: kann aktiv oder gelöscht werden
StatusAtlasRelationship	Status für atlas-Beziehung
TimeBoundary	Erfasst Details zur Zeitgrenze

AtlasClassification

Ein instance einer Klassifizierung. Es verfügt über 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 sein. Gelöschte Entitäten werden nicht entfernt.
lastModifiedTS	string	ETag für die Parallelitätssteuerung.
removePropagationsOnEntityDelete	boolean	Bestimmt, ob Weitergaben beim Löschen von Entitäten entfernt werden.
typeName	string	Der Name des Typs.
validityPeriods	TimeBoundary[]	Ein Array von Zeitgrenzen, die Gültigkeitsdauern angeben.

AtlasEntityHeader

Ein instance 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[]	Bezeichnungen
lastModifiedTS	string	ETag für die Parallelitätssteuerung.
meaningNames	string[]	Ein Array von Bedeutungen.
meanings	AtlasTermAssignmentHeader[]	Ein Array von Begriffszuweisungsheadern.
status	EntityStatus	Status der Entität – kann aktiv oder gelöscht sein. Gelöschte Entitäten werden nicht entfernt.
typeName	string	Der Name des Typs.

AtlasErrorResponse

Eine Fehlerantwort des Diensts

Name	Typ	Beschreibung
errorCode	string	Der Fehlercode.
errorMessage	string	Die Fehlermeldung.
requestId	string	Die Anforderungs-ID.

AtlasObjectId

Verweis auf ein objekt-instance eines Typs - wie Entität.

Name	Typ	Beschreibung
guid	string	Die GUID des -Objekts.
typeName	string	Der Name des Typs.
uniqueAttributes		Die eindeutigen Attribute des Objekts.

AtlasRelationship

Atlas-Beziehung instance.

Name	Typ	Beschreibung
attributes		Die Attribute der Struktur.
createTime	integer	Die erstellungszeit des Datensatzes.
createdBy	string	Der Benutzer, der den Datensatz erstellt hat.
end1	AtlasObjectId	Verweis auf ein objekt-instance eines Typs - wie Entität.
end2	AtlasObjectId	Verweis auf ein objekt-instance eines Typs - wie Entität.
guid	string	Die GUID der Beziehung.
homeId	string	Die Start-ID der Beziehung.
label	string	Die Bezeichnung der Beziehung.
lastModifiedTS	string	ETag für die Parallelitätssteuerung.
provenanceType	integer	Wird verwendet, um die Herkunft einer instance einer Entität oder Beziehung aufzuzeichnen.
status	StatusAtlasRelationship	Die Enumeration der Beziehung status.
typeName	string	Der Name des Typs.
updateTime	integer	Die Aktualisierungszeit des Datensatzes.
updatedBy	string	Der Benutzer, der den Datensatz aktualisiert hat.
version	integer	Die Version der Beziehung.

AtlasRelationshipWithExtInfo

Die Beziehung zu erweiterten Informationen.

Name	Typ	Beschreibung
referredEntities	<string, AtlasEntityHeader>	Der verwiesene Entitätsheader.
relationship	AtlasRelationship	Atlas-Beziehung instance.

AtlasTermAssignmentHeader

Der Header für die Ausdruckszuweisung.

Name	Typ	Beschreibung
confidence	integer	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 des Begriffs Zuweisung.
relationGuid	string	Die GUID der Beziehung.
status	AtlasTermAssignmentStatus	Die status der Begriffszuweisung.
steward	string	Der Steward des Begriffs.
termGuid	string	Die GUID des Begriffs.

AtlasTermAssignmentStatus

Status für Begriffszuweisung

Name	Typ	Beschreibung
DEPRECATED	string	Die status ist veraltet.
DISCOVERED	string	Die status wird ermittelt.
IMPORTED	string	Die status wird importiert.
OBSOLETE	string	Die status ist veraltet.
OTHER	string	Andere status.
PROPOSED	string	Die status wird vorgeschlagen.
VALIDATED	string	Die status wird überprüft.

EntityStatus

Status: kann aktiv oder gelöscht werden

Name	Typ	Beschreibung
ACTIVE	string	Die status ist aktiv.
DELETED	string	Die status wird gelöscht.

StatusAtlasRelationship

Status für atlas-Beziehung

Name	Typ	Beschreibung
ACTIVE	string	aktiv
DELETED	string	deleted

TimeBoundary

Erfasst Details zur Zeitgrenze

Name	Typ	Beschreibung
endTime	string	Das Ende der Zeitgrenze.
startTime	string	Der Beginn der Zeitgrenze.
timeZone	string	Die Zeitzone der Zeitgrenze.

Freigeben über