Freigeben über

Relationship - Get

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

Dient zum 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 (uri)

guid
 path True

string

Der global eindeutige Bezeichner der Beziehung.
extendedInfo
 query

boolean

Beschränkt, ob erweiterte Informationen enthalten sind.

Antworten

Name Typ Beschreibung
200 OK

AtlasRelationshipWithExtInfo

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

Relationship_Get

Beispielanforderung

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

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
AtlasObjectId

Verweisen auf eine Objektinstanz eines Typs – z. B. Entität.
AtlasRelationship

Atlas-Beziehungsinstanz.
AtlasRelationshipWithExtInfo

Die Beziehung mit erweiterten Informationen.
AtlasTermAssignmentHeader

Der Header für die Ausdruckszuweisung.
AtlasTermAssignmentStatus

Status für Die Begriffszuweisung
EntityStatus

Status – kann aktiv oder gelöscht werden
StatusAtlasRelationship

Status für Atlas-Beziehung
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.

AtlasObjectId

Objekt

Verweisen auf eine Objektinstanz eines Typs – z. B. Entität.

Name Typ Beschreibung
guid

string

Die GUID des Objekts.
typeName

string

Der Name des Typs.
uniqueAttributes

Die eindeutigen Attribute des Objekts.

AtlasRelationship

Objekt

Atlas-Beziehungsinstanz.

Name Typ Beschreibung
attributes

Die Attribute der Struktur.
createTime

integer (int64)

Die erstellte Zeit des Datensatzes.
createdBy

string

Der Benutzer, der den Datensatz erstellt hat.
end1

AtlasObjectId

Verweisen auf eine Objektinstanz eines Typs – z. B. Entität.
end2

AtlasObjectId

Verweisen auf eine Objektinstanz eines Typs – z. B. 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 Parallelitätssteuerelement.
provenanceType

integer (int32)

Wird verwendet, um die Provenienz einer Instanz einer Entität oder Beziehung aufzuzeichnen.
status

StatusAtlasRelationship

Die Enumeration des Beziehungsstatus.
typeName

string

Der Name des Typs.
updateTime

integer (int64)

Die Aktualisierungszeit des Datensatzes.
updatedBy

string

Der Benutzer, der den Datensatz aktualisiert hat.
version

integer (int64)

Die Version der Beziehung.

AtlasRelationshipWithExtInfo

Objekt

Die Beziehung mit erweiterten Informationen.

Name Typ Beschreibung
referredEntities

<string,  AtlasEntityHeader>

Der Referenzentitätsheader.
relationship

AtlasRelationship

Atlas-Beziehungsinstanz.

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.

StatusAtlasRelationship

Enumeration

Status für Atlas-Beziehung

Wert Beschreibung
ACTIVE

aktiv
DELETED

deleted

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.