通过

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

Glossary - Create Terms

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

批量创建术语表术语。

POST {endpoint}/datamap/api/atlas/v2/glossary/terms
具有可选参数: 
POST {endpoint}/datamap/api/atlas/v2/glossary/terms?api-version=2023-09-01&includeTermHierarchy={includeTermHierarchy}

URI 参数

名称 在 必需 类型 说明
endpoint
 path True

string (uri)

api-version
 query

string

minLength: 1

用于此操作的 API 版本。
includeTermHierarchy
 query

boolean

是否包括术语层次结构

请求正文

名称 类型 说明
body

AtlasGlossaryTerm[]

要批量创建的术语表术语定义的数组。

响应

名称 类型 说明
200 OK

AtlasGlossaryTerm[]

请求已成功。
Other Status Codes

AtlasErrorResponse

意外的错误响应。

安全性

OAuth2Auth

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

作用域

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

示例

Glossary_CreateTerms

示例请求

POST {endpoint}/datamap/api/atlas/v2/glossary/terms?api-version=2023-09-01

[
  {
    "anchor": {
      "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8"
    },
    "name": "ExampleTerm2",
    "status": "Approved",
    "shortDescription": "Example Short Description",
    "longDescription": "Example Long Description",
    "abbreviation": "T2",
    "resources": [
      {
        "displayName": "Example Display Name",
        "url": "Example Url"
      }
    ]
  },
  {
    "anchor": {
      "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8"
    },
    "name": "ExampleTerm3",
    "status": "Approved",
    "shortDescription": "Example Short Description",
    "longDescription": "Example Long Description",
    "abbreviation": "T3",
    "resources": [
      {
        "displayName": "Example Display Name",
        "url": "Example Url"
      }
    ]
  }
]

示例响应

状态代码:
200 
[
  {
    "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"
    },
    "resources": [
      {
        "displayName": "Example Display Name",
        "url": "Example Url"
      }
    ]
  },
  {
    "guid": "821beef0-ced9-47ba-8f7f-c4f3459f4d18",
    "qualifiedName": "ExampleTerm3@Glossary",
    "name": "ExampleTerm3",
    "shortDescription": "Example Short Description",
    "lastModifiedTS": "1",
    "abbreviation": "T3",
    "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": "f4de4878-3e43-4f8b-b090-07a233bb0ce6"
    },
    "resources": [
      {
        "displayName": "Example Display Name",
        "url": "Example Url"
      }
    ]
  }
]

定义

名称 说明
AtlasClassification

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

来自服务的错误响应
AtlasGlossaryHeader

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

术语表术语。
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。

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[]

相关术语标头数组作为其他记录的有效值。

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 术语关系的状态

值 说明
DRAFT

草稿
ACTIVE

积极
DEPRECATED

弃用的
OBSOLETE

已过时
OTHER

其他

EntityStatus

枚举

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

值 说明
ACTIVE

状态处于活动状态。
DELETED

状态已删除。

PurviewObjectId

Object

PurviewObjectId

名称 类型 说明
displayText

string

显示文本
guid

string

对象的 GUID。
itemPath

string

项路径
name

string

名字
properties

任何字典<>
resourceId

string

资源 ID
typeName

string

类型的名称。
uniqueAttributes

对象的唯一属性。
Object

ResourceLink

名称 类型 说明
displayName

string

URL 的显示名称。
url

string

web url。 http 或 https

StatusAtlasRelationship

枚举

atlas 关系的状态

值 说明
ACTIVE

积极
DELETED

删除

TermStatus

枚举

术语的状态

值 说明
Draft

草稿
Approved

批准
Alert

警报
Expired

过期

TimeBoundary

Object

捕获时间边界详细信息

名称 类型 说明
endTime

string

时间边界的结束。
startTime

string

时间边界的开始。
timeZone

string

时间边界的时区。