Glossary - Get Detailed

Referenz

Dienst:: Purview

API-Version:: 2023-09-01

Rufen Sie ein bestimmtes Glossar mit detaillierten Informationen ab. Diese API wird nicht empfohlen.

Es wird empfohlen, Begriffe/Kategoriendetails separat abzurufen.

GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms und

GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.

GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/detailed

Mit optionalen Parametern:

GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/detailed?api-version=2023-09-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string
glossaryId	path	True	string	Der global eindeutige Bezeichner für das Glossar.
api-version	query		string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	AtlasGlossaryExtInfo	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

Glossary_GetDetailed

Beispielanforderung

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary/c018ddaf-7c21-4b37-a838-dae5f110c3d8/detailed?api-version=2023-09-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
  "qualifiedName": "Glossary",
  "name": "Glossary",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "language": "en",
  "usage": "Example Glossary",
  "createdBy": "ExampleCreator",
  "updatedBy": "ExampleUpdator",
  "createTime": 1672892675688,
  "updateTime": 1672892675688,
  "terms": [
    {
      "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
      "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0",
      "displayText": "ExampleTerm1"
    },
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189",
      "displayText": "ExampleTerm2"
    }
  ],
  "categories": [
    {
      "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
      "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2"
    },
    {
      "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
      "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0"
    },
    {
      "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
      "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d"
    }
  ],
  "termInfo": {
    "54688d39-b298-4104-9e80-f2a16f44aaea": {
      "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
      "qualifiedName": "ExampleTerm1@Glossary",
      "name": "ExampleTerm1",
      "shortDescription": "Example Short Description",
      "longDescription": "Example Long Description",
      "lastModifiedTS": "2",
      "abbreviation": "T1",
      "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "createTime": 1606287247276,
      "updateTime": 1606290587593,
      "status": "Approved",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
      },
      "assignedEntities": [
        {
          "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0",
          "typeName": "hdfs_path",
          "entityStatus": "ACTIVE",
          "displayText": "1",
          "relationshipType": "AtlasGlossarySemanticAssignment",
          "relationshipGuid": "cf2e959c-05e6-4a9f-b106-b6475741c2ba",
          "relationshipStatus": "ACTIVE",
          "relationshipAttributes": {
            "typeName": "AtlasGlossarySemanticAssignment",
            "attributes": {
              "expression": "Example Expression",
              "createdBy": "ExampleCreator",
              "steward": "ExampleSteward",
              "confidence": 100,
              "description": "Example Description",
              "source": "Azure",
              "status": null
            }
          }
        }
      ],
      "categories": [
        {
          "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
          "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007"
        }
      ],
      "seeAlso": [
        {
          "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
          "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
          "displayText": "ExampleTerm2"
        }
      ],
      "synonyms": [
        {
          "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
          "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
          "displayText": "ExampleTerm2"
        }
      ],
      "contacts": {
        "Expert": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Expert Info"
          }
        ],
        "Steward": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Steward Info"
          }
        ]
      },
      "resources": [
        {
          "displayName": "Example Display Name",
          "url": "Example Url"
        }
      ]
    },
    "952c7ba4-4c89-42d8-a05a-7d2161be7008": {
      "guid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "qualifiedName": "ExampleTerm2@Glossary",
      "name": "ExampleTerm2",
      "shortDescription": "Example Short Description",
      "lastModifiedTS": "1",
      "abbreviation": "T2",
      "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "createTime": 1606287312495,
      "updateTime": 1606287312495,
      "status": "Approved",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189"
      },
      "seeAlso": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
          "displayText": "ExampleTerm1"
        }
      ],
      "synonyms": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
          "displayText": "ExampleTerm1"
        }
      ],
      "resources": [
        {
          "displayName": "Example Display Name",
          "url": "Example Url"
        }
      ]
    }
  },
  "categoryInfo": {
    "ed7458f0-9463-48a5-b5c6-4f785fb34e12": {
      "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
      "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary",
      "name": "ExampleCategory1",
      "longDescription": "Example Long Description",
      "lastModifiedTS": "3",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0"
      },
      "parentCategory": {
        "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
        "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20"
      },
      "childrenCategories": [
        {
          "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
          "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f"
        }
      ],
      "terms": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007",
          "displayText": "ExampleTerm1"
        }
      ]
    },
    "e47c4584-daca-4f9e-9092-194e04692c9a": {
      "guid": "e47c4584-daca-4f9e-9092-194e04692c9a",
      "qualifiedName": "ExampleCategory2@Glossary",
      "name": "ExampleCategory2",
      "lastModifiedTS": "1",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d"
      },
      "childrenCategories": [
        {
          "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
          "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20"
        }
      ]
    },
    "0d6766f6-f4b6-435b-bda2-d3edc358998e": {
      "guid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
      "qualifiedName": "ExampleCategory3.ExampleCategory1.ExampleCategory2@Glossary",
      "name": "ExampleCategory3",
      "lastModifiedTS": "2",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2"
      },
      "parentCategory": {
        "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
        "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f"
      }
    }
  }
}

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.
AtlasErrorResponse	Eine Fehlerantwort des Diensts
AtlasGlossaryCategory	Die Glossarkategorie.
AtlasGlossaryExtInfo	Die erweiterten Informationen des Glossars.
AtlasGlossaryHeader	Der Glossarheader mit grundlegenden Informationen.
AtlasGlossaryTerm	Der Glossarbegriff.
AtlasRelatedCategoryHeader	Der Header der zugehörigen Kategorie.
AtlasRelatedObjectId	Verweis auf ein Objekt-instance des AtlasEntity-Typs, der in Beziehungsattributwerten verwendet wird
AtlasRelatedTermHeader	Der Header des zugehörigen Begriffs.
AtlasStruct	Erfasst Details des Strukturinhalts. Nicht direkt instanziiert, wird nur über AtlasEntity, AtlasClassification verwendet.
AtlasTermCategorizationHeader	Die grundlegenden Informationen zur Begriffskategorisierung.
AtlasTermRelationshipStatus	Status für Atlas-Ausdrucksbeziehung
EntityStatus	Status: kann aktiv oder gelöscht werden
PurviewObjectId	PurviewObjectId
ResourceLink	ResourceLink
StatusAtlasRelationship	Status für atlas-Beziehung
TermStatus	Status für Begriff
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.

AtlasErrorResponse

Eine Fehlerantwort des Diensts

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

AtlasGlossaryCategory

Die Glossarkategorie.

Name	Typ	Beschreibung
anchor	AtlasGlossaryHeader	Der Glossarheader mit grundlegenden Informationen.
childrenCategories	AtlasRelatedCategoryHeader[]	Ein Array untergeordneter Kategorien.
classifications	AtlasClassification[]	Ein Array von Klassifizierungen.
createTime	integer	Die erstellungszeit des Datensatzes.
createdBy	string	Der Benutzer, der den Datensatz erstellt hat.
guid	string	Die GUID des -Objekts.
lastModifiedTS	string	ETag für die Parallelitätssteuerung.
longDescription	string	Die Beschreibung der langen Version.
name	string	Der Name des Glossarobjekts.
parentCategory	AtlasRelatedCategoryHeader	Der Header der zugehörigen Kategorie.
qualifiedName	string	Der qualifizierte Name des Glossarobjekts.
shortDescription	string	Die Kurzversion der Beschreibung.
terms	AtlasRelatedTermHeader[]	Ein Array verwandter Begriffsheader.
updateTime	integer	Die Aktualisierungszeit des Datensatzes.
updatedBy	string	Der Benutzer, der den Datensatz aktualisiert hat.

AtlasGlossaryExtInfo

Die erweiterten Informationen des Glossars.

Name	Typ	Beschreibung
categories	AtlasRelatedCategoryHeader[]	Ein Array von Kategorien.
categoryInfo	<string, AtlasGlossaryCategory>	Die Glossarkategorieinformationen.
classifications	AtlasClassification[]	Ein Array von Klassifizierungen.
createTime	integer	Die erstellungszeit des Datensatzes.
createdBy	string	Der Benutzer, der den Datensatz erstellt hat.
guid	string	Die GUID des -Objekts.
language	string	Die Sprache des Glossars.
lastModifiedTS	string	ETag für die Parallelitätssteuerung.
longDescription	string	Die Beschreibung der langen Version.
name	string	Der Name des Glossarobjekts.
qualifiedName	string	Der qualifizierte Name des Glossarobjekts.
shortDescription	string	Die Kurzversion der Beschreibung.
termInfo	<string, AtlasGlossaryTerm>	Informationen zum Glossar.
terms	AtlasRelatedTermHeader[]	Ein Array verwandter Begriffsheader.
updateTime	integer	Die Aktualisierungszeit des Datensatzes.
updatedBy	string	Der Benutzer, der den Datensatz aktualisiert hat.
usage	string	Die Verwendung des Glossars.

AtlasGlossaryHeader

Der Glossarheader mit grundlegenden Informationen.

Name	Typ	Beschreibung
displayText	string	Der Anzeigetext.
glossaryGuid	string	Die GUID des Glossars.
relationGuid	string	Die GUID der Beziehung.

AtlasGlossaryTerm

Der Glossarbegriff.

Name	Typ	Beschreibung
abbreviation	string	Die Abkürzung des Begriffs.
anchor	AtlasGlossaryHeader	Der Glossarheader mit grundlegenden Informationen.
antonyms	AtlasRelatedTermHeader[]	Ein Array verwandter Begriffsheader als Antonyme.
assignedEntities	AtlasRelatedObjectId[]	Ein Array verwandter Objekt-IDs.
attributes	object	Die benutzerdefinierten Attribute des Begriffs, der map<string, map<string, object>> ist. Der Schlüssel der ersten Ebenenzuordnung ist der Begriff Vorlagenname.
categories	AtlasTermCategorizationHeader[]	Ein Array von Begriffskategorisierungsheadern.
classifications	AtlasClassification[]	Ein Array von Klassifizierungen.
classifies	AtlasRelatedTermHeader[]	Ein Array verwandter Begriffsheader.
contacts	object	Das Wörterbuch der Kontakte für Begriffe. Schlüssel kann Expert oder Steward sein.
createTime	integer	Die erstellungszeit des Datensatzes.
createdBy	string	Der Benutzer, der den Datensatz erstellt hat.
examples	string[]	Ein Array von Beispielen.
guid	string	Die GUID des -Objekts.
hierarchyInfo	PurviewObjectId[]	Die Hierarchieinformationen des Begriffs.
isA	AtlasRelatedTermHeader[]	Ein Array verwandter Begriffsheader, die die Is-a-Beziehung angibt.
lastModifiedTS	string	ETag für die Parallelitätssteuerung.
longDescription	string	Die Beschreibung der langen Version.
name	string	Der Name des Glossarobjekts.
nickName	string	Der Spitzname des Begriffs.
preferredTerms	AtlasRelatedTermHeader[]	Ein Array bevorzugter verwandter Begriffsheader.
preferredToTerms	AtlasRelatedTermHeader[]	Ein Array verwandter Begriffsheader, die bevorzugt werden.
qualifiedName	string	Der qualifizierte Name des Glossarobjekts.
replacedBy	AtlasRelatedTermHeader[]	Ein Array verwandter Begriffsheader, die durch ersetzt werden.
replacementTerms	AtlasRelatedTermHeader[]	Ein Array verwandter Begriffsheader zur Ersetzung.
resources	ResourceLink[]	Ein Array von Ressourcenlinks für den Begriff
seeAlso	AtlasRelatedTermHeader[]	Ein Array verwandter Begriffsheader für siehe auch.
shortDescription	string	Die Kurzversion der Beschreibung.
status	TermStatus	Status des AtlasGlossaryTerm
synonyms	AtlasRelatedTermHeader[]	Ein Array verwandter Begriffsheader als Synonyme.
templateName	TemplateName[]	Der Name der Vorlage.
translatedTerms	AtlasRelatedTermHeader[]	Ein Array von übersetzten verwandten Begriffsheadern.
translationTerms	AtlasRelatedTermHeader[]	Ein Array verwandter Begriffsheader für die Übersetzung.
updateTime	integer	Die Aktualisierungszeit des Datensatzes.
updatedBy	string	Der Benutzer, der den Datensatz aktualisiert hat.
usage	string	Die Verwendung des Begriffs.
validValues	AtlasRelatedTermHeader[]	Ein Array verwandter Begriffsheader als gültige Werte.
validValuesFor	AtlasRelatedTermHeader[]	Ein Array verwandter Begriffsheader als gültige Werte für andere Datensätze.

AtlasRelatedCategoryHeader

Der Header der zugehörigen Kategorie.

Name	Typ	Beschreibung
categoryGuid	string	Die GUID der Kategorie.
description	string	Die Beschreibung des Kategorieheaders.
displayText	string	Der Anzeigetext.
parentCategoryGuid	string	Die GUID der übergeordneten Kategorie.
relationGuid	string	Die GUID der Beziehung.

AtlasRelatedObjectId

Verweis auf ein Objekt-instance des AtlasEntity-Typs, der in Beziehungsattributwerten verwendet wird

Name	Typ	Beschreibung
displayText	string	Der Anzeigetext.
entityStatus	EntityStatus	Status der Entität – kann aktiv oder gelöscht sein. Gelöschte Entitäten werden nicht entfernt.
guid	string	Die GUID des -Objekts.
relationshipAttributes	AtlasStruct	Erfasst Details des Strukturinhalts. Nicht direkt instanziiert, wird nur über AtlasEntity, AtlasClassification verwendet.
relationshipGuid	string	Die GUID der Beziehung.
relationshipStatus	StatusAtlasRelationship	Die Enumeration der Beziehung status.
relationshipType	string	Beziehungstyp
typeName	string	Der Name des Typs.
uniqueAttributes		Die eindeutigen Attribute des Objekts.

AtlasRelatedTermHeader

Der Header des zugehörigen Begriffs.

Name	Typ	Beschreibung
description	string	Die Beschreibung des zugehörigen Begriffs.
displayText	string	Der Anzeigetext.
expression	string	Der Ausdruck des Begriffs.
relationGuid	string	Die GUID der Beziehung.
status	AtlasTermRelationshipStatus	Die status der Begriffsbeziehung.
steward	string	Der Steward des Begriffs.
termGuid	string	Die GUID des Begriffs.

AtlasStruct

Erfasst Details des Strukturinhalts. Nicht direkt instanziiert, wird nur über AtlasEntity, AtlasClassification verwendet.

Name	Typ	Beschreibung
attributes		Die Attribute der Struktur.
lastModifiedTS	string	ETag für die Parallelitätssteuerung.
typeName	string	Der Name des Typs.

AtlasTermCategorizationHeader

Die grundlegenden Informationen zur Begriffskategorisierung.

Name	Typ	Beschreibung
categoryGuid	string	Die GUID der Kategorie.
description	string	Die Beschreibung des Datensatzes.
displayText	string	Der Anzeigetext.
relationGuid	string	Die GUID der Beziehung.
status	AtlasTermRelationshipStatus	Die status der Begriffsbeziehung.

AtlasTermRelationshipStatus

Status für Atlas-Ausdrucksbeziehung

Name	Typ	Beschreibung
ACTIVE	string	aktiv
DEPRECATED	string	deprecated
DRAFT	string	Entwurf
OBSOLETE	string	Veraltet
OTHER	string	Andere

EntityStatus

Status: kann aktiv oder gelöscht werden

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

PurviewObjectId

Name	Typ	Beschreibung
displayText	string	Anzeigetext
guid	string	Die GUID des -Objekts.
itemPath	string	Elementpfad
name	string	Name
properties		Wörterbuch von
resourceId	string	Ressourcen-ID
typeName	string	Der Name des Typs.
uniqueAttributes		Die eindeutigen Attribute des Objekts.

ResourceLink

Name	Typ	Beschreibung
displayName	string	Anzeigename für URL.
url	string	Web-URL. HTTP oder HTTPS

StatusAtlasRelationship

Status für atlas-Beziehung

Name	Typ	Beschreibung
ACTIVE	string	aktiv
DELETED	string	deleted

TermStatus

Status für Begriff

Name	Typ	Beschreibung
Alert	string	Warnung
Approved	string	Genehmigt
Draft	string	Entwurf
Expired	string	Abgelaufen

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