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

Glossary - Assign Term To Entities

将给定术语分配给提供的相关对象列表。 建议对多个 API 调用使用小批量。

实体创建或更新操作 是将术语分配给多个实体的替代方法。

POST {endpoint}/datamap/api/atlas/v2/glossary/terms/{termId}/assignedEntities

URI 参数

名称 必需 类型 说明
endpoint
path True

string

termId
path True

string

术语表术语的全局唯一标识符。

请求正文

名称 类型 说明
body

AtlasRelatedObjectId[]

术语必须关联的相关对象 ID 的数组。

响应

名称 类型 说明
204 No Content

没有要为此请求发送的内容,但标头可能很有用。

Other Status Codes

AtlasErrorResponse

意外的错误响应。

安全性

OAuth2Auth

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

作用域

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

示例

Glossary_AssignTermToEntities

示例请求

POST {endpoint}/datamap/api/atlas/v2/glossary/terms/8a7f65ec-6429-0b9b-3734-ec57bf1e34c2/assignedEntities

[
  {
    "guid": "ab9f1920-0b94-436d-aeb4-11a32c270fc0",
    "relationshipAttributes": {
      "attributes": {
        "expression": "Example Expression",
        "confidence": 100,
        "description": "Example Description",
        "source": "ExampleSource"
      }
    }
  }
]

示例响应

定义

名称 说明
AtlasErrorResponse

来自服务的错误响应

AtlasRelatedObjectId

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

AtlasStruct

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

EntityStatus

状态 - 可以是活动状态,也可以已删除

StatusAtlasRelationship

atlas 关系的状态

AtlasErrorResponse

来自服务的错误响应

名称 类型 说明
errorCode

string

错误代码。

errorMessage

string

错误消息。

requestId

string

请求 ID。

AtlasRelatedObjectId

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

名称 类型 说明
displayText

string

显示文本。

entityStatus

EntityStatus

实体的状态 - 可以是活动状态,也可以是已删除的。 不会删除已删除的实体。

guid

string

对象的 GUID。

relationshipAttributes

AtlasStruct

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

relationshipGuid

string

关系的 GUID。

relationshipStatus

StatusAtlasRelationship

关系状态的枚举。

relationshipType

string

关系类型

typeName

string

类型的名称。

uniqueAttributes

对象的唯一属性。

AtlasStruct

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

名称 类型 说明
attributes

结构的属性。

lastModifiedTS

string

用于并发控制的 ETag。

typeName

string

类型的名称。

EntityStatus

状态 - 可以是活动状态,也可以已删除

名称 类型 说明
ACTIVE

string

状态为“活动”。

DELETED

string

状态已删除。

StatusAtlasRelationship

atlas 关系的状态

名称 类型 说明
ACTIVE

string

活动

DELETED

string

deleted