Entity - Get By Unique Attributes

Referenz

Dienst:: Purview

API-Version:: 2023-09-01

Rufen Sie die vollständige Definition einer Entität anhand des Typs und des eindeutigen Attributs ab.

Zusätzlich zum pfadparameter typeName können Attributschlüssel-Wert-Paare im folgenden Format bereitgestellt werden: attr:<attrName>=.

HINWEIS: AttrName und attrValue sollten entitätsübergreifend eindeutig sein, z. B. Qualifiedname.

Die REST-Anforderung würde in etwa wie folgt aussehen: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}

Mit optionalen Parametern:

GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}?minExtInfo={minExtInfo}&ignoreRelationships={ignoreRelationships}&attr:qualifiedName={attr:qualifiedName}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string
typeName	path	True	string	Der Name des Typs.
attr:qualifiedName	query		string	Der qualifizierte Name der Entität. (Dies ist nur ein Beispiel. qualifiedName kann in andere eindeutige Attribute geändert werden.)
ignoreRelationships	query		boolean	Gibt an, ob Beziehungsattribute ignoriert werden sollen.
minExtInfo	query		boolean	Gibt an, ob minimale Informationen für verwiesene Entitäten zurückgegeben werden sollen.

Antworten

Name	Typ	Beschreibung
200 OK	AtlasEntityWithExtInfo	Die Anforderung war erfolgreich.
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

Entity_GetByUniqueAttributes

Beispielanforderung

HTTP

GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/azure_storage_account?minExtInfo=True&attr:qualifiedName=https://exampleaccount.core.windows.net

Beispiel für eine Antwort

Statuscode:: 200

{
  "entity": {
    "createTime": 1605703532110,
    "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
    "guid": "e0ba3f20-f3b5-4d52-b769-ed35a02df60a",
    "relationshipAttributes": {
      "services": [],
      "meanings": []
    },
    "status": "ACTIVE",
    "updateTime": 1605703532110,
    "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
    "lastModifiedTS": "2",
    "version": 0,
    "attributes": {
      "owner": "ExampleOwner",
      "qualifiedName": "https://exampleaccount.core.windows.net",
      "createTime": 0,
      "name": "ExampleNewName"
    },
    "typeName": "azure_storage_account"
  },
  "referredEntities": {}
}

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.
AtlasEntity	Eine instance einer Entität , z. B. hive_table, hive_database.
AtlasEntityWithExtInfo	Eine instance einer Entität zusammen mit erweiterten Informationen , z. B. hive_table, hive_database.
AtlasErrorResponse	Eine Fehlerantwort des Diensts
AtlasTermAssignmentHeader	Der Header für die Ausdruckszuweisung.
AtlasTermAssignmentStatus	Status der Begriffszuweisung
EntityStatus	Status: kann aktiv sein oder gelöscht werden
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 sein oder gelöscht werden. 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, das Gültigkeitsdauern angibt.

AtlasEntity

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

Name	Typ	Beschreibung
attributes		Die Attribute der Struktur.
businessAttributes		Geschäftsattribute
classifications	AtlasClassification[]	Ein Array von Klassifizierungen.
collectionId	string	Die Sammlungs-ID der Entität.
contacts	object	Das Wörterbuch der Kontakte für Entitäten. Schlüssel kann Experte oder Besitzer sein.
createTime	integer	Die Erstellungszeit des Datensatzes.
createdBy	string	Der Benutzer, der den Datensatz erstellt hat.
customAttributes	object	Benutzerdefiniertes Attribut
guid	string	Die GUID der Entität.
homeId	string	Die Start-ID der Entität.
isIncomplete	boolean	Gibt an, ob es sich um eine Shellentität handelt
labels	string[]	Bezeichnungen
lastModifiedTS	string	ETag für die Parallelitätssteuerung.
meanings	AtlasTermAssignmentHeader[]	Ein Array von Begriffszuweisungsheadern, die die Bedeutung der Entität angeben.
provenanceType	integer	Wird verwendet, um die Herkunft einer instance einer Entität oder Beziehung aufzuzeichnen.
proxy	boolean	Bestimmt, ob ein Proxy vorhanden ist.
relationshipAttributes		Die Attribute der Beziehung.
status	EntityStatus	Status der Entität: Kann aktiv sein oder gelöscht werden. Gelöschte Entitäten werden nicht entfernt.
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 Entität.

AtlasEntityWithExtInfo

Eine instance einer Entität zusammen mit erweiterten Informationen , z. B. hive_table, hive_database.

Name	Typ	Beschreibung
entity	AtlasEntity	Eine instance einer Entität , z. B. hive_table, hive_database.
referredEntities	<string, AtlasEntity>	Die verwiesenen Entitäten.

AtlasErrorResponse

Eine Fehlerantwort des Diensts

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

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 assignment.
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 der 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 sein oder gelöscht werden

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

TimeBoundary

Erfasst Details zur Zeitgrenze

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