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

Glossary - Create Glossary Term

创建术语表术语。

POST {Endpoint}/catalog/api/atlas/v2/glossary/term
POST {Endpoint}/catalog/api/atlas/v2/glossary/term?includeTermHierarchy={includeTermHierarchy}

URI 参数

Name In Required Type Description
Endpoint
path True
  • string

Purview 帐户的目录终结点。 示例:https://{accountName}.purview.azure.com

includeTermHierarchy
query
  • boolean

是否包含术语层次结构

请求正文

Name Type Description
abbreviation
  • string

术语的缩写。

anchor

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

antonyms

一个由相关术语标头作为调理的数组。

assignedEntities

相关对象 ID 的数组。

attributes
  • object

attributes
术语的自定义属性,即映射<字符串、映射<字符串、对象>>。 第一层映射的键是术语模板名称。

categories

术语分类标头数组。

classifications

分类数组。

classifies

相关术语标头的数组。

contacts
  • object

术语联系人字典。 关键可以是专家或管家。

createTime
  • number

记录的创建时间。

createdBy
  • string

创建记录的用户。

examples
  • string[]

示例数组。

guid
  • string

对象的 GUID。

isA

一个相关术语标头数组,指示 is-a 关系。

lastModifiedTS
  • string

lastModifiedTS
用于并发控制的 ETag。

longDescription
  • string

长版本说明。

name
  • string

术语表对象的名称。

preferredTerms

首选相关术语标头的数组。

preferredToTerms

首选相关术语标头的数组。

qualifiedName
  • string

术语表对象的限定名称。

replacedBy

替换为的相关术语标头的数组。

replacementTerms

用于替换的相关术语标头的数组。

resources

术语的资源链接数组

seeAlso

另请参阅相关术语标头的数组。

shortDescription
  • string

描述的简短版本。

status

状态
AtlasGlossaryTerm 的状态

synonyms

相关术语标头作为同义词的数组。

templateName
  • object[]
translatedTerms

已翻译的相关术语标头的数组。

translationTerms

用于翻译的相关术语标头的数组。

updateTime
  • number

记录的更新时间。

updatedBy
  • string

更新记录的用户。

usage
  • string

术语的用法。

validValues

相关术语标头的数组作为有效值。

validValuesFor

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

响应

Name Type Description
200 OK

没问题。 如果术语表术语创建成功。

Other Status Codes

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Glossary_CreateGlossaryTerm
Glossary_CreateGlossaryTermWithTermTemplate

Glossary_CreateGlossaryTerm

Sample Request

POST {Endpoint}/catalog/api/atlas/v2/glossary/term

{
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "abbreviation": "T1",
  "status": "Approved",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8"
  },
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ],
  "contacts": {
    "Expert": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Expert Info"
      }
    ],
    "Steward": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Steward info"
      }
    ]
  }
}

Sample Response

{
  "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
  "qualifiedName": "ExampleTerm1@Glossary",
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "longDescription": "Example Long Description",
  "abbreviation": "T1",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "createTime": 1606287247276,
  "updateTime": 1606287247276,
  "status": "Approved",
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ],
  "contacts": {
    "Expert": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Expert Info"
      }
    ],
    "Steward": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Steward Info"
      }
    ]
  }
}

Glossary_CreateGlossaryTermWithTermTemplate

Sample Request

POST {Endpoint}/catalog/api/atlas/v2/glossary/term

{
  "name": "ExampleTerm",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8"
  },
  "attributes": {
    "ExampleTermTemplateAttribute": {
      "plain string": "Example String",
      "date": 1606233600000,
      "single choice": "Example Single Choice A",
      "multi choice": [
        "Example Multi Choice A",
        "Example Multi Choice B"
      ]
    }
  }
}

Sample Response

{
  "guid": "9390cc82-1077-403e-a4d2-b6a69834707b",
  "qualifiedName": "ExampleTerm@Glossary",
  "name": "ExampleTerm",
  "lastModifiedTS": "1",
  "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "createTime": 1606287247276,
  "updateTime": 1606287247276,
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "attributes": {
    "ExampleTermTemplateAttribute": {
      "plain string": "Example String",
      "date": 1606233600000,
      "single choice": "Example Single Choice A",
      "multi choice": [
        "Example Multi Choice A",
        "Example Multi Choice B"
      ]
    }
  }
}

定义

AtlasClassification

AtlasClassification

AtlasGlossaryHeader

AtlasGlossaryHeader

AtlasGlossaryTerm

AtlasGlossaryTerm

AtlasRelatedObjectId

AtlasRelatedObjectId

AtlasRelatedTermHeader

AtlasRelatedTermHeader

AtlasStruct

AtlasStruct

AtlasTermCategorizationHeader

AtlasTermCategorizationHeader

AtlasTermRelationshipStatus

AtlasTermRelationshipStatus

Attributes

结构的属性。

ErrorResponse

来自服务的错误响应

ResourceLink

ResourceLink

SourceDetails

有关源信息的更多详细信息

Status

状态

Status_AtlasRelationship

状态

TermStatus

状态

TimeBoundary

TimeBoundary

UniqueAttributes

对象的唯一属性。

AtlasClassification

AtlasClassification

Name Type Description
attributes

结构的属性。

entityGuid
  • string

实体的 GUID。

entityStatus

状态
实体的状态 - 可以处于活动状态或删除。 不会从 Atlas 存储中删除已删除的实体。

lastModifiedTS
  • string

lastModifiedTS
用于并发控制的 ETag。

removePropagationsOnEntityDelete
  • boolean

确定在实体删除时是否删除传播。

source
  • string

指示创建分类详细信息的源

sourceDetails

有关源信息的更多详细信息

typeName
  • string

类型的名称。

validityPeriods

一个时间边界数组,指示有效期。

AtlasGlossaryHeader

AtlasGlossaryHeader

Name Type Description
displayText
  • string

显示文本。

glossaryGuid
  • string

术语表的 GUID。

relationGuid
  • string

关系的 GUID。

AtlasGlossaryTerm

AtlasGlossaryTerm

Name Type Description
abbreviation
  • string

术语的缩写。

anchor

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

antonyms

一个由相关术语标头作为调理的数组。

assignedEntities

相关对象 ID 的数组。

attributes
  • object

attributes
术语的自定义属性,即映射<字符串、映射<字符串、对象>>。 第一层映射的键是术语模板名称。

categories

术语分类标头数组。

classifications

分类数组。

classifies

相关术语标头的数组。

contacts
  • object

术语联系人字典。 关键可以是专家或管家。

createTime
  • number

记录的创建时间。

createdBy
  • string

创建记录的用户。

examples
  • string[]

示例数组。

guid
  • string

对象的 GUID。

isA

一个相关术语标头数组,指示 is-a 关系。

lastModifiedTS
  • string

lastModifiedTS
用于并发控制的 ETag。

longDescription
  • string

长版本说明。

name
  • string

术语表对象的名称。

preferredTerms

首选相关术语标头的数组。

preferredToTerms

首选相关术语标头的数组。

qualifiedName
  • string

术语表对象的限定名称。

replacedBy

替换为的相关术语标头的数组。

replacementTerms

用于替换的相关术语标头的数组。

resources

术语的资源链接数组

seeAlso

另请参阅相关术语标头的数组。

shortDescription
  • string

描述的简短版本。

status

状态
AtlasGlossaryTerm 的状态

synonyms

相关术语标头作为同义词的数组。

templateName
  • object[]
translatedTerms

已翻译的相关术语标头的数组。

translationTerms

用于翻译的相关术语标头的数组。

updateTime
  • number

记录的更新时间。

updatedBy
  • string

更新记录的用户。

usage
  • string

术语的用法。

validValues

相关术语标头的数组作为有效值。

validValuesFor

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

AtlasRelatedObjectId

AtlasRelatedObjectId

Name Type Description
displayText
  • string

显示文本。

entityStatus

状态
实体的状态 - 可以处于活动状态或删除。 不会从 Atlas 存储中删除已删除的实体。

guid
  • string

对象的 GUID。

relationshipAttributes

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

relationshipGuid
  • string

关系的 GUID。

relationshipStatus

状态
关系状态的枚举。

relationshipType
  • string
typeName
  • string

类型的名称。

uniqueAttributes

对象的唯一属性。

AtlasRelatedTermHeader

AtlasRelatedTermHeader

Name Type Description
description
  • string

相关术语的说明。

displayText
  • string

显示文本。

expression
  • string

术语的表达式。

relationGuid
  • string

关系的 GUID。

source
  • string

术语的源。

status

AtlasTermRelationshipStatus
术语关系的状态。

steward
  • string

术语的管家。

termGuid
  • string

术语的 GUID。

AtlasStruct

AtlasStruct

Name Type Description
attributes

结构的属性。

lastModifiedTS
  • string

lastModifiedTS
用于并发控制的 ETag。

typeName
  • string

类型的名称。

AtlasTermCategorizationHeader

AtlasTermCategorizationHeader

Name Type Description
categoryGuid
  • string

类别的 GUID。

description
  • string

记录的说明。

displayText
  • string

显示文本。

relationGuid
  • string

关系的 GUID。

status

AtlasTermRelationshipStatus
术语关系的状态。

AtlasTermRelationshipStatus

AtlasTermRelationshipStatus

Name Type Description
ACTIVE
  • string
DEPRECATED
  • string
DRAFT
  • string
OBSOLETE
  • string
OTHER
  • string

Attributes

结构的属性。

Name Type Description

ErrorResponse

来自服务的错误响应

Name Type Description
errorCode
  • string

错误代码。

errorMessage
  • string

错误消息。

requestId
  • string

请求 ID。

ResourceLink

Name Type Description
displayName
  • string

URL 的显示名称。

url
  • string

Web URL。 http 或 https

SourceDetails

有关源信息的更多详细信息

Name Type Description

Status

状态

Name Type Description
ACTIVE
  • string
DELETED
  • string

Status_AtlasRelationship

状态

Name Type Description
ACTIVE
  • string
DELETED
  • string

TermStatus

状态

Name Type Description
Alert
  • string
Approved
  • string
Draft
  • string
Expired
  • string

TimeBoundary

TimeBoundary

Name Type Description
endTime
  • string

时间边界的结束。

startTime
  • string

时间边界的开始。

timeZone
  • string

时间边界的时区。

UniqueAttributes

对象的唯一属性。

Name Type Description