Glossary - List Related Terms

Referenz

Dienst:: Purview

API-Version:: 2023-09-01

Rufen Sie alle verwandten Ausdrücke für einen bestimmten Ausdruck anhand der GUID ab. Limit-, Offset- und Sortierparameter werden derzeit nicht aktiviert und funktionieren nicht, auch wenn sie übergeben werden.

GET {endpoint}/datamap/api/atlas/v2/glossary/terms/{termId}/related

Mit optionalen Parametern:

GET {endpoint}/datamap/api/atlas/v2/glossary/terms/{termId}/related?api-version=2023-09-01&limit={limit}&offset={offset}&sort={sort}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)
termId	path	True	string	Der global eindeutige Bezeichner für den Glossarausdruck.
api-version	query		string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
limit	query		integer (int32)	Die Seitengröße - standardmäßig gibt es keine Seitenverwaltung.
offset	query		integer (int32)	Der Offset für paginierungszwecke.
sort	query		string	Die Sortierreihenfolge, ASC (Standard) oder DESC.

Antworten

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

Beispielanforderung

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary/terms/54688d39-b298-4104-9e80-f2a16f44aaea/related?api-version=2023-09-01&limit=-1&offset=0&sort=ASC

Beispiel für eine Antwort

Statuscode:: 200

{
  "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"
    }
  ]
}

Definitionen

AtlasErrorResponse

Objekt

Eine Fehlerantwort des Diensts

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

Freigeben über