Glossary - Get Detailed

Referenz

Dienst:: Purview

API-Version:: 2023-09-01

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

Empfehlen, Begriffs-/Kategoriendetails separat mithilfe von

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 (uri)
glossaryId	path	True	string	Der global eindeutige Bezeichner für Glossare.
api-version	query		string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

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

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	Eine Instanz einer Klassifizierung; es hat 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 Glossarkopf mit grundlegenden Informationen.
AtlasGlossaryTerm	Der Glossarausdruck.
AtlasRelatedCategoryHeader	Die Kopfzeile der zugehörigen Kategorie.
AtlasRelatedObjectId	Verweis auf eine Objektinstanz des AtlasEntity-Typs, der in Beziehungattributwerten verwendet wird
AtlasRelatedTermHeader	Die Kopfzeile des zugehörigen Ausdrucks.
AtlasStruct	Erfasst Details des Strukturinhalts. Nicht direkt instanziiert, verwendet nur über AtlasEntity, AtlasClassification.
AtlasTermCategorizationHeader	Die grundlegenden Informationen für die Begriffskategorisierung.
AtlasTermRelationshipStatus	Status für Atlas-Begriffsbeziehung
EntityStatus	Status – kann aktiv oder gelöscht werden
PurviewObjectId	PurviewObjectId
ResourceLink	ResourceLink
StatusAtlasRelationship	Status für Atlas-Beziehung
TermStatus	Status für Ausdruck
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.

AtlasErrorResponse

Objekt

Eine Fehlerantwort des Diensts

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

AtlasGlossaryCategory

Objekt

Die Glossarkategorie.

Name	Typ	Beschreibung
anchor	AtlasGlossaryHeader	Der Glossarkopf mit grundlegenden Informationen.
childrenCategories	AtlasRelatedCategoryHeader[]	Ein Array von untergeordneten Kategorien.
classifications	AtlasClassification[]	Ein Array von Klassifizierungen.
createTime	integer (int64)	Die erstellte Zeit des Datensatzes.
createdBy	string	Der Benutzer, der den Datensatz erstellt hat.
guid	string	Die GUID des Objekts.
lastModifiedTS	string	ETag für Parallelitätssteuerelement.
longDescription	string	Die Beschreibung der langen Version.
name	string	Der Name des Glossarobjekts.
parentCategory	AtlasRelatedCategoryHeader	Die Kopfzeile der zugehörigen Kategorie.
qualifiedName	string	Der qualifizierte Name des Glossarobjekts.
shortDescription	string	Die kurze Version der Beschreibung.
terms	AtlasRelatedTermHeader[]	Ein Array verwandter Ausdrucksheader.
updateTime	integer (int64)	Die Aktualisierungszeit des Datensatzes.
updatedBy	string	Der Benutzer, der den Datensatz aktualisiert hat.

AtlasGlossaryExtInfo

Objekt

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 (int64)	Die erstellte Zeit 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 Parallelitätssteuerelement.
longDescription	string	Die Beschreibung der langen Version.
name	string	Der Name des Glossarobjekts.
qualifiedName	string	Der qualifizierte Name des Glossarobjekts.
shortDescription	string	Die kurze Version der Beschreibung.
termInfo	<string, AtlasGlossaryTerm>	Die Glossarausdrucksinformationen.
terms	AtlasRelatedTermHeader[]	Ein Array verwandter Ausdrucksheader.
updateTime	integer (int64)	Die Aktualisierungszeit des Datensatzes.
updatedBy	string	Der Benutzer, der den Datensatz aktualisiert hat.
usage	string	Die Verwendung des Glossars.

AtlasGlossaryHeader

Objekt

Der Glossarkopf mit grundlegenden Informationen.

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

AtlasGlossaryTerm

Objekt

Der Glossarausdruck.

Name	Typ	Beschreibung
abbreviation	string	Die Abkürzung des Begriffs.
anchor	AtlasGlossaryHeader	Der Glossarkopf mit grundlegenden Informationen.
antonyms	AtlasRelatedTermHeader[]	Ein Array verwandter Ausdruckskopfzeilen als Antonyme.
assignedEntities	AtlasRelatedObjectId[]	Ein Array verwandter Objekt-IDs.
attributes	object	Die benutzerdefinierten Attribute des Ausdrucks, die<Zeichenfolge,Zuordnung<Zeichenfolge,Objekt>>zugeordnet ist. Der Schlüssel der ersten Layerzuordnung ist der Name der Begriffsvorlagen.
categories	AtlasTermCategorizationHeader[]	Ein Array von Begriffskategorisierungsheadern.
classifications	AtlasClassification[]	Ein Array von Klassifizierungen.
classifies	AtlasRelatedTermHeader[]	Ein Array verwandter Ausdrucksheader.
contacts	object	Das Wörterbuch der Kontakte für Begriffe. Schlüssel könnte Expert oder Steward sein.
createTime	integer (int64)	Die erstellte Zeit 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 Ausdrucks.
isA	AtlasRelatedTermHeader[]	Ein Array verwandter Ausdrucksheader, die angibt, dass es sich um eine Beziehung handelt.
lastModifiedTS	string	ETag für Parallelitätssteuerelement.
longDescription	string	Die Beschreibung der langen Version.
name	string	Der Name des Glossarobjekts.
nickName	string	Der Nickname des Begriffs.
preferredTerms	AtlasRelatedTermHeader[]	Ein Array bevorzugter verwandter Ausdrucksheader.
preferredToTerms	AtlasRelatedTermHeader[]	Ein Array verwandter Ausdrucksheader, die bevorzugt werden.
qualifiedName	string	Der qualifizierte Name des Glossarobjekts.
replacedBy	AtlasRelatedTermHeader[]	Ein Array verwandter Ausdrucksheader, die ersetzt werden.
replacementTerms	AtlasRelatedTermHeader[]	Ein Array verwandter Ausdrucksheader zur Ersetzung.
resources	ResourceLink[]	Ein Array der Ressourcenverknüpfung für einen Ausdruck
seeAlso	AtlasRelatedTermHeader[]	Ein Array verwandter Ausdruckskopfzeilen für siehe auch.
shortDescription	string	Die kurze Version der Beschreibung.
status	TermStatus	Status des AtlasGlossaryTerm
synonyms	AtlasRelatedTermHeader[]	Ein Array verwandter Ausdrucksheader als Synonyme.
templateName	TemplateName[]	Der Name der Vorlage.
translatedTerms	AtlasRelatedTermHeader[]	Ein Array übersetzter verwandter Ausdrucksheader.
translationTerms	AtlasRelatedTermHeader[]	Ein Array verwandter Ausdrucksheader für die Übersetzung.
updateTime	integer (int64)	Die Aktualisierungszeit des Datensatzes.
updatedBy	string	Der Benutzer, der den Datensatz aktualisiert hat.
usage	string	Die Verwendung des Begriffs.
validValues	AtlasRelatedTermHeader[]	Ein Array verwandter Ausdrucksheader als gültige Werte.
validValuesFor	AtlasRelatedTermHeader[]	Ein Array verwandter Ausdrucksheader als gültige Werte für andere Datensätze.

AtlasRelatedCategoryHeader

Objekt

Die Kopfzeile der zugehörigen Kategorie.

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

AtlasRelatedObjectId

Objekt

Verweis auf eine Objektinstanz des AtlasEntity-Typs, der in Beziehungattributwerten verwendet wird

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

AtlasRelatedTermHeader

Objekt

Die Kopfzeile des zugehörigen Ausdrucks.

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

AtlasStruct

Objekt

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

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

AtlasTermCategorizationHeader

Objekt

Die grundlegenden Informationen für die Begriffskategorisierung.

Name	Typ	Beschreibung
categoryGuid	string (uuid)	Die GUID der Kategorie.
description	string	Die Beschreibung des Datensatzes.
displayText	string	Der Anzeigetext.
relationGuid	string (uuid)	Die GUID der Beziehung.
status	AtlasTermRelationshipStatus	Der Status der Ausdrucksbeziehung.

AtlasTermRelationshipStatus

Enumeration

Status für Atlas-Begriffsbeziehung

Wert	Beschreibung
ACTIVE	aktiv
DEPRECATED	veraltet
DRAFT	Entwurf
OBSOLETE	obsolet
OTHER	andere

EntityStatus

Enumeration

Status – kann aktiv oder gelöscht werden

Wert	Beschreibung
ACTIVE	Der Status ist aktiv.
DELETED	Der Status wird gelöscht.

PurviewObjectId

Objekt

PurviewObjectId

Name	Typ	Beschreibung
displayText	string	Anzeigen von Text
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

Objekt

ResourceLink

Name	Typ	Beschreibung
displayName	string	Anzeigename für URL.
url	string	Web-URL. http oder https

StatusAtlasRelationship

Enumeration

Status für Atlas-Beziehung

Wert	Beschreibung
ACTIVE	aktiv
DELETED	gelöscht

TermStatus

Enumeration

Status für Ausdruck

Wert	Beschreibung
Alert	wachsam
Approved	gebilligt
Draft	Entwurf
Expired	abgelaufen

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.

Freigeben über

Glossary - Get Detailed

URI-Parameter

Antworten

Sicherheit

OAuth2Auth

Bereiche

Beispiele

Glossary_GetDetailed

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AtlasClassification

AtlasErrorResponse

AtlasGlossaryCategory

AtlasGlossaryExtInfo

AtlasGlossaryHeader

AtlasGlossaryTerm

AtlasRelatedCategoryHeader

AtlasRelatedObjectId

AtlasRelatedTermHeader

AtlasStruct

AtlasTermCategorizationHeader

AtlasTermRelationshipStatus

EntityStatus

PurviewObjectId

ResourceLink

StatusAtlasRelationship

TermStatus

TimeBoundary

Zusätzliche Ressourcen