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

Glossary - List Category Terms

获取与特定类别关联的所有术语。

GET {endpoint}/datamap/api/atlas/v2/glossary/category/{categoryId}/terms
GET {endpoint}/datamap/api/atlas/v2/glossary/category/{categoryId}/terms?limit={limit}&offset={offset}&sort={sort}

URI 参数

名称 必需 类型 说明
categoryId
path True

string

类别的全局唯一标识符。

endpoint
path True

string (uri)

limit
query

integer (int32)

页面大小 - 默认情况下没有分页。

offset
query

integer (int32)

分页的偏移量。

sort
query

string

排序顺序、ASC(默认)或 DESC。

响应

名称 类型 说明
200 OK

AtlasRelatedTermHeader[]

请求已成功。

Other Status Codes

AtlasErrorResponse

意外的错误响应。

安全性

OAuth2Auth

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

作用域

名称 说明
https://purview.azure.net/.default

示例

Glossary_ListCategoryTerms

示例请求

GET {endpoint}/datamap/api/atlas/v2/glossary/category/ed7458f0-9463-48a5-b5c6-4f785fb34e12/terms?limit=-1&offset=0&sort=ASC

示例响应

[
  {
    "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
    "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007",
    "displayText": "ExampleTerm1"
  }
]

定义

名称 说明
AtlasErrorResponse

来自服务的错误响应

AtlasRelatedTermHeader

相关术语的标头。

AtlasTermRelationshipStatus

atlas 术语关系的状态

AtlasErrorResponse

来自服务的错误响应

名称 类型 说明
errorCode

string

错误代码。

errorMessage

string

错误消息。

requestId

string (uuid)

请求 ID。

AtlasRelatedTermHeader

相关术语的标头。

名称 类型 说明
description

string

相关术语的说明。

displayText

string

显示文本。

expression

string

术语的表达式。

relationGuid

string

关系的 GUID。

status

AtlasTermRelationshipStatus

术语关系的状态。

steward

string

术语的管家。

termGuid

string

术语的 GUID。

AtlasTermRelationshipStatus

atlas 术语关系的状态

说明
ACTIVE

活跃

DEPRECATED

荒废的

DRAFT

草稿

OBSOLETE

过时

OTHER

其他