Glossary - List Related Terms

服務:
Purview
API 版本:
2023-09-01

依 GUID 取得特定字詞的所有相關字詞。 限制、位移和排序參數目前未啟用，即使傳遞，也不會運作。

GET {endpoint}/datamap/api/atlas/v2/glossary/terms/{termId}/related
含選擇性參數: 
GET {endpoint}/datamap/api/atlas/v2/glossary/terms/{termId}/related?api-version=2023-09-01&limit={limit}&offset={offset}&sort={sort}

URI 參數

名稱 位於 必要 類型 Description
endpoint
 path True

string (uri)

termId
 path True

string

詞彙的全域唯一標識碼。
api-version
 query

string

minLength: 1

要用於這項作業的 API 版本。
limit
 query

integer (int32)

頁面大小 - 預設沒有分頁。
offset
 query

integer (int32)

分頁用途的位移。
sort
 query

string

排序順序、ASC（預設值）或 DESC。

回應

名稱 類型 Description
200 OK

要求已成功。
Other Status Codes

AtlasErrorResponse

未預期的錯誤回應。

安全性

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
https://purview.azure.net/.default

範例

Glossary_ListRelatedTerms

範例要求

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

範例回覆

狀態碼:
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"
    }
  ]
}

定義

AtlasErrorResponse

Object

來自服務的錯誤回應

名稱 類型 Description
errorCode

string

錯誤碼。
errorMessage

string

錯誤訊息。
requestId

string (uuid)

要求標識碼。