Glossary - List

參考

服務:: Purview

API 版本:: 2023-09-01

取得所有詞彙。建議使用限制/位移來取得分頁結果。建議使用 'ignoreTermsAndCategories=true' 並分別使用 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' 和 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories' 來擷取字詞/類別。

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string
api-version	query		string	要用於這項作業的 API 版本。
ignoreTermsAndCategories	query		boolean	是否忽略字詞和類別
limit	query		integer int32	頁面大小 - 預設沒有分頁。
offset	query		integer int32	分頁用途的位移。
sort	query		string	排序順序、ASC（預設值）或 DESC。

回應

名稱	類型	Description
200 OK	AtlasGlossary[]	要求已成功。
Other Status Codes	AtlasErrorResponse	未預期的錯誤回應。

安全性

OAuth2Auth

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

範圍

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

範例

Glossary_List

範例要求

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary?api-version=2023-09-01&limit=1&offset=0&sort=ASC

範例回覆

狀態碼:: 200

[
  {
    "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "qualifiedName": "Glossary",
    "name": "Glossary",
    "shortDescription": "Example Short Description",
    "longDescription": "Example Long Description",
    "lastModifiedTS": "1",
    "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",
        "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
        "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2",
        "displayText": "ExampleCategory3"
      },
      {
        "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
        "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
        "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0",
        "displayText": "ExampleCategory1"
      },
      {
        "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
        "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d",
        "displayText": "ExampleCategory2"
      }
    ]
  }
]

定義

名稱	Description
AtlasClassification	分類的實例;它沒有身分識別，此物件只有在與實體相關聯時才會存在。
AtlasErrorResponse	來自服務的錯誤回應
AtlasGlossary	詞彙物件。
AtlasRelatedCategoryHeader	相關類別的標頭。
AtlasRelatedTermHeader	相關詞彙的標頭。
AtlasTermRelationshipStatus	atlas 字詞關聯性的狀態
EntityStatus	狀態 - 可以是使用中或刪除
TimeBoundary	擷取時間界限詳細數據

AtlasClassification

分類的實例;它沒有身分識別，此物件只有在與實體相關聯時才會存在。

名稱	類型	Description
attributes		結構的屬性。
entityGuid	string	實體的 GUID。
entityStatus	EntityStatus	實體的狀態 - 可以是作用中或刪除。不會移除已刪除的實體。
lastModifiedTS	string	用於並行控制的 ETag。
removePropagationsOnEntityDelete	boolean	判斷實體刪除時是否要移除傳播。
typeName	string	型別的名稱。
validityPeriods	TimeBoundary[]	時間界限的陣列，表示有效期間。

AtlasErrorResponse

來自服務的錯誤回應

名稱	類型	Description
errorCode	string	錯誤碼。
errorMessage	string	錯誤訊息。
requestId	string	要求標識碼。

AtlasGlossary

詞彙物件。

名稱	類型	Description
categories	AtlasRelatedCategoryHeader[]	類別陣列。
classifications	AtlasClassification[]	分類陣列。
createTime	integer	記錄的建立時間。
createdBy	string	建立記錄的使用者。
guid	string	物件的 GUID。
language	string	詞彙的語言。
lastModifiedTS	string	用於並行控制的 ETag。
longDescription	string	完整版本描述。
name	string	詞彙物件的名稱。
qualifiedName	string	詞彙物件的限定名稱。
shortDescription	string	簡短的描述版本。
terms	AtlasRelatedTermHeader[]	相關字詞標頭的陣列。
updateTime	integer	記錄的更新時間。
updatedBy	string	更新記錄的使用者。
usage	string	詞彙的使用方式。

AtlasRelatedCategoryHeader

相關類別的標頭。

名稱	類型	Description
categoryGuid	string	類別的 GUID。
description	string	類別標題的描述。
displayText	string	顯示文字。
parentCategoryGuid	string	父類別目錄的 GUID。
relationGuid	string	關聯性的 GUID。

AtlasRelatedTermHeader

相關詞彙的標頭。

名稱	類型	Description
description	string	相關詞彙的描述。
displayText	string	顯示文字。
expression	string	詞彙的表達式。
relationGuid	string	關聯性的 GUID。
status	AtlasTermRelationshipStatus	詞彙關聯性的狀態。
steward	string	詞彙的管理者。
termGuid	string	詞彙的 GUID。

AtlasTermRelationshipStatus

atlas 字詞關聯性的狀態

名稱	類型	Description
ACTIVE	string	積極
DEPRECATED	string	荒廢的
DRAFT	string	草案
OBSOLETE	string	過時
OTHER	string	其他

EntityStatus

狀態 - 可以是使用中或刪除

名稱	類型	Description
ACTIVE	string	狀態為作用中。
DELETED	string	狀態已刪除。

TimeBoundary

擷取時間界限詳細數據

名稱	類型	Description
endTime	string	時間界限的結尾。
startTime	string	時間界限的開始。
timeZone	string	時間界限的時區。

共用方式為