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

Glossary - Get Detailed

参考

服务:: Purview

API 版本:: 2023-09-01

获取包含详细信息的特定术语表。不建议使用此 API。

建议分别使用提取术语/类别详细信息

GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and

GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories。

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

具有可选参数:

GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/detailed?api-version=2023-09-01

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)
glossaryId	path	True	string	术语表的全局唯一标识符。
api-version	query		string minLength: 1	用于此操作的 API 版本。

响应

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

安全性

OAuth2Auth

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

作用域

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

示例

Glossary_GetDetailed

示例请求

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary/c018ddaf-7c21-4b37-a838-dae5f110c3d8/detailed?api-version=2023-09-01

示例响应

状态代码:: 200

{
  "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
  "qualifiedName": "Glossary",
  "name": "Glossary",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "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",
      "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2"
    },
    {
      "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
      "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0"
    },
    {
      "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
      "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d"
    }
  ],
  "termInfo": {
    "54688d39-b298-4104-9e80-f2a16f44aaea": {
      "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
      "qualifiedName": "ExampleTerm1@Glossary",
      "name": "ExampleTerm1",
      "shortDescription": "Example Short Description",
      "longDescription": "Example Long Description",
      "lastModifiedTS": "2",
      "abbreviation": "T1",
      "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "createTime": 1606287247276,
      "updateTime": 1606290587593,
      "status": "Approved",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
      },
      "assignedEntities": [
        {
          "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0",
          "typeName": "hdfs_path",
          "entityStatus": "ACTIVE",
          "displayText": "1",
          "relationshipType": "AtlasGlossarySemanticAssignment",
          "relationshipGuid": "cf2e959c-05e6-4a9f-b106-b6475741c2ba",
          "relationshipStatus": "ACTIVE",
          "relationshipAttributes": {
            "typeName": "AtlasGlossarySemanticAssignment",
            "attributes": {
              "expression": "Example Expression",
              "createdBy": "ExampleCreator",
              "steward": "ExampleSteward",
              "confidence": 100,
              "description": "Example Description",
              "source": "Azure",
              "status": null
            }
          }
        }
      ],
      "categories": [
        {
          "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
          "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007"
        }
      ],
      "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"
        }
      ],
      "contacts": {
        "Expert": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Expert Info"
          }
        ],
        "Steward": [
          {
            "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
            "info": "Example Steward Info"
          }
        ]
      },
      "resources": [
        {
          "displayName": "Example Display Name",
          "url": "Example Url"
        }
      ]
    },
    "952c7ba4-4c89-42d8-a05a-7d2161be7008": {
      "guid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "qualifiedName": "ExampleTerm2@Glossary",
      "name": "ExampleTerm2",
      "shortDescription": "Example Short Description",
      "lastModifiedTS": "1",
      "abbreviation": "T2",
      "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
      "createTime": 1606287312495,
      "updateTime": 1606287312495,
      "status": "Approved",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189"
      },
      "seeAlso": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
          "displayText": "ExampleTerm1"
        }
      ],
      "synonyms": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
          "displayText": "ExampleTerm1"
        }
      ],
      "resources": [
        {
          "displayName": "Example Display Name",
          "url": "Example Url"
        }
      ]
    }
  },
  "categoryInfo": {
    "ed7458f0-9463-48a5-b5c6-4f785fb34e12": {
      "guid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
      "qualifiedName": "ExampleCategory1.ExampleCategory2@Glossary",
      "name": "ExampleCategory1",
      "longDescription": "Example Long Description",
      "lastModifiedTS": "3",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0"
      },
      "parentCategory": {
        "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
        "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20"
      },
      "childrenCategories": [
        {
          "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
          "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f"
        }
      ],
      "terms": [
        {
          "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
          "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007",
          "displayText": "ExampleTerm1"
        }
      ]
    },
    "e47c4584-daca-4f9e-9092-194e04692c9a": {
      "guid": "e47c4584-daca-4f9e-9092-194e04692c9a",
      "qualifiedName": "ExampleCategory2@Glossary",
      "name": "ExampleCategory2",
      "lastModifiedTS": "1",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d"
      },
      "childrenCategories": [
        {
          "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
          "relationGuid": "82d569cd-2273-4ef9-9f67-c6f2ed637c20"
        }
      ]
    },
    "0d6766f6-f4b6-435b-bda2-d3edc358998e": {
      "guid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
      "qualifiedName": "ExampleCategory3.ExampleCategory1.ExampleCategory2@Glossary",
      "name": "ExampleCategory3",
      "lastModifiedTS": "2",
      "anchor": {
        "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
        "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2"
      },
      "parentCategory": {
        "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
        "relationGuid": "e50be8c5-7905-4c92-b676-4278866c2c2f"
      }
    }
  }
}

定义

名称	说明
AtlasClassification	分类的实例;它没有标识，此对象仅在与实体关联时才存在。
AtlasErrorResponse	来自服务的错误响应
AtlasGlossaryCategory	术语表类别。
AtlasGlossaryExtInfo	术语表的扩展信息。
AtlasGlossaryHeader	包含基本信息的术语表头。
AtlasGlossaryTerm	术语表术语。
AtlasRelatedCategoryHeader	相关类别的标头。
AtlasRelatedObjectId	对关系属性值中使用的 AtlasEntity 类型的对象实例的引用
AtlasRelatedTermHeader	相关术语的标头。
AtlasStruct	捕获结构内容的详细信息。不直接实例化，仅通过 AtlasEntity、AtlasClassification 使用。
AtlasTermCategorizationHeader	术语分类的基本信息。
AtlasTermRelationshipStatus	atlas 术语关系的状态
EntityStatus	状态 - 可以处于活动状态或删除
PurviewObjectId	PurviewObjectId
ResourceLink	ResourceLink
StatusAtlasRelationship	atlas 关系的状态
TermStatus	术语的状态
TimeBoundary	捕获时间边界详细信息

AtlasClassification

Object

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

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

AtlasErrorResponse

Object

来自服务的错误响应

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

AtlasGlossaryCategory

Object

术语表类别。

名称	类型	说明
anchor	AtlasGlossaryHeader	包含基本信息的术语表头。
childrenCategories	AtlasRelatedCategoryHeader[]	子类别的数组。
classifications	AtlasClassification[]	分类数组。
createTime	integer (int64)	记录的创建时间。
createdBy	string	创建记录的用户。
guid	string	对象的 GUID。
lastModifiedTS	string	用于并发控制的 ETag。
longDescription	string	长版本说明。
name	string	术语表对象的名称。
parentCategory	AtlasRelatedCategoryHeader	相关类别的标头。
qualifiedName	string	术语表对象的限定名称。
shortDescription	string	说明的简短版本。
terms	AtlasRelatedTermHeader[]	相关术语标头的数组。
updateTime	integer (int64)	记录的更新时间。
updatedBy	string	更新记录的用户。

AtlasGlossaryExtInfo

Object

术语表的扩展信息。

名称	类型	说明
categories	AtlasRelatedCategoryHeader[]	类别数组。
categoryInfo	<string, AtlasGlossaryCategory>	术语表类别信息。
classifications	AtlasClassification[]	分类数组。
createTime	integer (int64)	记录的创建时间。
createdBy	string	创建记录的用户。
guid	string	对象的 GUID。
language	string	术语表的语言。
lastModifiedTS	string	用于并发控制的 ETag。
longDescription	string	长版本说明。
name	string	术语表对象的名称。
qualifiedName	string	术语表对象的限定名称。
shortDescription	string	说明的简短版本。
termInfo	<string, AtlasGlossaryTerm>	术语表术语信息。
terms	AtlasRelatedTermHeader[]	相关术语标头的数组。
updateTime	integer (int64)	记录的更新时间。
updatedBy	string	更新记录的用户。
usage	string	术语表的用法。

AtlasGlossaryHeader

Object

包含基本信息的术语表头。

名称	类型	说明
displayText	string	显示文本。
glossaryGuid	string	术语表的 GUID。
relationGuid	string	关系的 GUID。

AtlasGlossaryTerm

Object

术语表术语。

名称	类型	说明
abbreviation	string	术语的缩写。
anchor	AtlasGlossaryHeader	包含基本信息的术语表头。
antonyms	AtlasRelatedTermHeader[]	一个由相关的术语标头作为一个参数数组。
assignedEntities	AtlasRelatedObjectId[]	相关对象 ID 的数组。
attributes	object	术语的自定义属性，映射<字符串，映射<字符串，对象>>。第一层映射的键是术语模板名称。
categories	AtlasTermCategorizationHeader[]	术语分类标头数组。
classifications	AtlasClassification[]	分类数组。
classifies	AtlasRelatedTermHeader[]	相关术语标头的数组。
contacts	object	术语的联系人字典。关键可以是专家或专员。
createTime	integer (int64)	记录的创建时间。
createdBy	string	创建记录的用户。
examples	string[]	示例数组。
guid	string	对象的 GUID。
hierarchyInfo	PurviewObjectId[]	术语的层次结构信息。
isA	AtlasRelatedTermHeader[]	指示 is-a relationship 的相关术语标头的数组。
lastModifiedTS	string	用于并发控制的 ETag。
longDescription	string	长版本说明。
name	string	术语表对象的名称。
nickName	string	术语的昵称。
preferredTerms	AtlasRelatedTermHeader[]	首选相关术语标头的数组。
preferredToTerms	AtlasRelatedTermHeader[]	首选相关术语标头的数组。
qualifiedName	string	术语表对象的限定名称。
replacedBy	AtlasRelatedTermHeader[]	被替换的相关术语标头的数组。
replacementTerms	AtlasRelatedTermHeader[]	要替换的相关术语标题的数组。
resources	ResourceLink[]	术语的资源链接数组
seeAlso	AtlasRelatedTermHeader[]	另请参阅相关术语标头的数组。
shortDescription	string	说明的简短版本。
status	TermStatus	AtlasGlossaryTerm 的状态
synonyms	AtlasRelatedTermHeader[]	相关术语标头作为同义词的数组。
templateName	TemplateName[]	模板的名称。
translatedTerms	AtlasRelatedTermHeader[]	已翻译的相关术语标头的数组。
translationTerms	AtlasRelatedTermHeader[]	用于翻译的相关术语标头的数组。
updateTime	integer (int64)	记录的更新时间。
updatedBy	string	更新记录的用户。
usage	string	术语的用法。
validValues	AtlasRelatedTermHeader[]	相关术语标头的数组作为有效值。
validValuesFor	AtlasRelatedTermHeader[]	相关术语标头数组作为其他记录的有效值。

AtlasRelatedCategoryHeader

Object

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

AtlasRelatedObjectId

Object

对关系属性值中使用的 AtlasEntity 类型的对象实例的引用

名称	类型	说明
displayText	string	显示文本。
entityStatus	EntityStatus	实体的状态 - 可以处于活动状态或删除。不会删除已删除的实体。
guid	string	对象的 GUID。
relationshipAttributes	AtlasStruct	捕获结构内容的详细信息。不直接实例化，仅通过 AtlasEntity、AtlasClassification 使用。
relationshipGuid	string (uuid)	关系的 GUID。
relationshipStatus	StatusAtlasRelationship	关系状态的枚举。
relationshipType	string	关系类型
typeName	string	类型的名称。
uniqueAttributes		对象的唯一属性。

AtlasRelatedTermHeader

Object

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

AtlasStruct

Object

捕获结构内容的详细信息。不直接实例化，仅通过 AtlasEntity、AtlasClassification 使用。

名称	类型	说明
attributes		结构的属性。
lastModifiedTS	string	用于并发控制的 ETag。
typeName	string	类型的名称。

AtlasTermCategorizationHeader

Object

术语分类的基本信息。

名称	类型	说明
categoryGuid	string (uuid)	类别的 GUID。
description	string	记录的说明。
displayText	string	显示文本。
relationGuid	string (uuid)	关系的 GUID。
status	AtlasTermRelationshipStatus	术语关系的状态。

AtlasTermRelationshipStatus

枚举

atlas 术语关系的状态

值	说明
ACTIVE	活跃
DEPRECATED	荒废的
DRAFT	草稿
OBSOLETE	过时
OTHER	其他

EntityStatus

枚举

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

值	说明
ACTIVE	状态处于活动状态。
DELETED	状态已删除。

PurviewObjectId

Object

PurviewObjectId

名称	类型	说明
displayText	string	显示文本
guid	string	对象的 GUID。
itemPath	string	项路径
name	string	名字
properties		字典
resourceId	string	资源 ID
typeName	string	类型的名称。
uniqueAttributes		对象的唯一属性。

ResourceLink

Object

ResourceLink

名称	类型	说明
displayName	string	URL 的显示名称。
url	string	web url。 http 或 https

StatusAtlasRelationship

枚举

atlas 关系的状态

值	说明
ACTIVE	活跃
DELETED	deleted

TermStatus

枚举

术语的状态

值	说明
Alert	警报
Approved	批准
Draft	草稿
Expired	过期

TimeBoundary

Object

捕获时间边界详细信息

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

通过

Glossary - Get Detailed

URI 参数

响应

安全性

OAuth2Auth

作用域

示例

Glossary_GetDetailed

示例请求

示例响应

定义

AtlasClassification

AtlasErrorResponse

AtlasGlossaryCategory

AtlasGlossaryExtInfo

AtlasGlossaryHeader

AtlasGlossaryTerm

AtlasRelatedCategoryHeader

AtlasRelatedObjectId

AtlasRelatedTermHeader

AtlasStruct

AtlasTermCategorizationHeader

AtlasTermRelationshipStatus

EntityStatus

PurviewObjectId

ResourceLink

StatusAtlasRelationship

TermStatus

TimeBoundary

其他资源