你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称	在	必需	类型	说明
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。

响应

名称	类型	说明
200 OK	AtlasGlossary[]	请求已成功。
Other Status Codes	AtlasErrorResponse	意外的错误响应。

安全性

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
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"
      }
    ]
  }
]

定义

名称	说明
AtlasClassification	分类的实例;它没有标识，此对象仅在与实体关联时才存在。
AtlasErrorResponse	来自服务的错误响应
AtlasGlossary	术语表对象。
AtlasRelatedCategoryHeader	相关类别的标头。
AtlasRelatedTermHeader	相关术语的标头。
AtlasTermRelationshipStatus	atlas 术语关系的状态
EntityStatus	状态 - 可以处于活动状态或删除
TimeBoundary	捕获时间边界详细信息

AtlasClassification

分类的实例;它没有标识，此对象仅在与实体关联时才存在。

名称	类型	说明
attributes		结构的属性。
entityGuid	string	实体的 GUID。
entityStatus	EntityStatus	实体的状态 - 可以处于活动状态或删除。不会删除已删除的实体。
lastModifiedTS	string	用于并发控制的 ETag。
removePropagationsOnEntityDelete	boolean	确定在删除实体时是否删除传播。
typeName	string	类型的名称。
validityPeriods	TimeBoundary[]	指示有效期的时间边界数组。

AtlasErrorResponse

来自服务的错误响应

名称	类型	说明
errorCode	string	错误代码。
errorMessage	string	错误消息。
requestId	string	请求 ID。

AtlasGlossary

术语表对象。

名称	类型	说明
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

名称	类型	说明
categoryGuid	string	类别的 GUID。
description	string	类别标头的说明。
displayText	string	显示文本。
parentCategoryGuid	string	父类别的 GUID。
relationGuid	string	关系的 GUID。

AtlasRelatedTermHeader

名称	类型	说明
description	string	相关术语的说明。
displayText	string	显示文本。
expression	string	术语的表达式。
relationGuid	string	关系的 GUID。
status	AtlasTermRelationshipStatus	术语关系的状态。
steward	string	术语的管家。
termGuid	string	术语的 GUID。

AtlasTermRelationshipStatus

atlas 术语关系的状态

名称	类型	说明
ACTIVE	string	积极
DEPRECATED	string	荒废的
DRAFT	string	草案
OBSOLETE	string	过时
OTHER	string	其他

EntityStatus

状态 - 可以处于活动状态或删除

名称	类型	说明
ACTIVE	string	状态处于活动状态。
DELETED	string	状态已删除。

TimeBoundary

捕获时间边界详细信息

名称	类型	说明
endTime	string	时间边界的结束。
startTime	string	时间边界的开始。
timeZone	string	时间边界的时区。

通过