通过

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

Azure 数据目录 REST API) (术语表

  • 项目

创建

创建单个术语表术语。

请求

POST https://api.azuredatacatalog.com/catalogs/{catalog_name}/glossaries/{glossary_name}/terms?api-version={api-version}

注意

某些 HTTP 客户端实现可能会自动重新发出请求以响应来自服务器的 302，但通常会从请求中删除 Authorization 标头 。 由于向 ADC 发出请求需要授权标头，因此必须确保在向 ADC 指定的重定向位置重新发出请求时仍提供授权标头。 下面是使用 .NET HttpWebRequest 对象演示这一点的示例代码。

URI 参数

名称 说明 数据类型
catalog_name 目录的名称，或“DefaultCatalog”以使用默认目录。 String
glossary_name 术语表的名称，默认与 catalog_name 相同。 使用“DefaultGlossary”选择默认术语表。 String
api-version API 版本。 String

POST 示例

POST https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/DefaultCatalog/glossaries/DefaultGlossary/terms?api-version=2016-03-30  

Content-Type: application/json x-ms-client-request-id: 13c45c14…46ab469473f0 Authorization: Bearer eyJ0eX ... FWSXfwtQ
#### 正文示例
{  
  "parentId" : "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/e44b497d-7e58-4e31-9ac5-f9d9bd97e199"  
  "name" : "Child",  
  "definition" : "termDefinition",  
  "stakeholders" : [  
    {  
      "objectId" : "bedc9058-980c-43a5-8b3b-1e7ce98b8cef",  
      "upn" : "test@example.com"  
    }  
  ]  
}

注意：

  1. 如果 body 不包含“parentId”，则创建的术语将是根术语，而不是父项。
  2. 如果两个术语具有相同的父术语，则不允许它们具有相同的名称。

响应

状态代码

代码 说明
201 Created. 请求已满足，并创建了一个新术语。
409 冲突。 同一父术语下已存在重复的术语名称。

Content-Type

application/json

标头

x-ms-request-id: 1095e88c…caffabd6dabd  
Location:  https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/b04e39a9-b457-4ab3-9da9-58b42be29577

删除

删除单个术语表术语。

请求

DELETE https://api.azuredatacatalog.com/catalogs/{catalog_name}/glossaries/{glossary_name}/terms/{term_id}?api-version={api-version}

注意

某些 HTTP 客户端实现可能会自动重新发出请求以响应来自服务器的 302，但通常会从请求中删除 Authorization 标头 。 由于向 ADC 发出请求需要授权标头，因此必须确保在向 ADC 指定的重定向位置重新发出请求时仍提供授权标头。 下面是使用 .NET HttpWebRequest 对象演示这一点的示例代码。

URI 参数

名称 说明 数据类型
catalog_name 目录的名称，或“DefaultCatalog”以使用默认目录。 String
glossary_name 术语表的名称，默认与 catalog_name 相同。 使用“DefaultGlossary”选择默认术语表。 String
term_id 术语表术语的 ID。 String
api-version API 版本。 String

DELETE 示例

DELETE https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/DefaultCatalog/glossaries/DefaultGlossary/terms/e44b497d-7e58-4e31-9ac5-f9d9bd97e199?api-version=2016-03-30

标头

x-ms-client-request-id: 8091955f…8f5b4c0acede Authorization: Bearer eXJ0eyAiOiJKV1QiLCJhbGciOi...

响应

状态代码

代码 说明
204 NoContent。 术语不存在或删除成功。
404 NotFound。 找不到术语。
412 前置条件失败。 由于 ETag 不匹配，请求已取消。

注意

Delete 操作语义为“如果存在则删除”，因此如果术语不存在，则返回成功状态代码 204 (NoContent) 。

Content-Type

application/json

标头

x-ms-request-id: 1095e88c…caffabd6dabd

枚举

枚举术语表中的所有术语。

请求

GET https://api.azuredatacatalog.com/catalogs/{catalog_name}/glossaries/{glossary_name}/terms?api-version={api-version}

注意

某些 HTTP 客户端实现可能会自动重新发出请求以响应来自服务器的 302，但通常会从请求中删除 Authorization 标头 。 由于向 ADC 发出请求需要授权标头，因此必须确保在向 ADC 指定的重定向位置重新发出请求时仍提供授权标头。 下面是使用 .NET HttpWebRequest 对象演示这一点的示例代码。

URI 参数

名称 说明 数据类型
catalog_name 目录的名称，或“DefaultCatalog”以使用默认目录。 String
glossary_name 术语表的名称，默认与 catalog_name 相同。 使用“DefaultGlossary”选择默认术语表。 String
api-version API 版本。 String

GET 示例

GET https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/DefaultCatalog/glossaries/DefaultGlossary/terms?api-version=2016-03-30

标头

x-ms-client-request-id: 8091955f…8f5b4c0acede Authorization: Bearer eXJ0eyAiOiJKV1QiLCJhbGciOi...

响应

状态代码

代码 说明
200 没问题。 响应包含术语表术语列表。

Content-Type

application/json

标头

x-ms-request-id: 1095e88c…caffabd6dabd  
Content-Type: application/json; charset=utf-8

正文

注意

每个枚举操作最多返回 1000 个字词。 如果术语表中的术语超过 1000 个，则连续枚举的响应中将包含“nextLink”。

{  
  "value": [  
    {  
      "parentId": "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/e44b497d-7e58-4e31-9ac5-f9d9bd97e199",  
      "id": "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/0cb37c31-6743-4d9d-bb4a-35716984fc57",  
      "name": "child2",  
      "definition": "termDefinition",  
      "stakeholders": [  
        {  
          "objectId": "bedc9058-980c-43a5-8b3b-1e7ce98b8cef",  
          "upn": "test@sample.com"  
        }  
      ],  
      "createdBy": {  
        "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
        "upn": "admin@billtest255158live.ccsctp.net"  
      },  
      "createdTime": "2016-03-03T17:18:09.6089982-08:00",  
      "modifiedBy": {  
        "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
        "upn": "admin@billtest255158live.ccsctp.net"  
      },  
      "modifiedTime": "2016-03-03T17:18:09.6089982-08:00"  
    },  
    {  
      "parentId": "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/e44b497d-7e58-4e31-9ac5-f9d9bd97e199",  
      "id": "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/60d51213-84cb-42ec-a331-98e283612c6a",  
      "name": "child1",  
      "definition": "termDefinition",  
      "stakeholders": [  
        {  
          "objectId": "bedc9058-980c-43a5-8b3b-1e7ce98b8cef",  
          "upn": "test@sample.com"  
        }  
      ],  
      "createdBy": {  
        "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
        "upn": "admin@billtest255158live.ccsctp.net"  
      },  
      "createdTime": "2016-03-03T17:18:00.3793795-08:00",  
      "modifiedBy": {  
        "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
        "upn": "admin@billtest255158live.ccsctp.net"  
      },  
      "modifiedTime": "2016-03-03T17:18:00.3793795-08:00"  
    },  
    {  
      "id": "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/19ce15d9-b25e-4f80-8dee-cfa9bdb57f1c",  
      "name": "root2",  
      "definition": "termDefinition",  
      "stakeholders": [  
        {  
          "objectId": "bedc9058-980c-43a5-8b3b-1e7ce98b8cef",  
          "upn": "test@sample.com"  
        }  
      ],  
      "createdBy": {  
        "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
        "upn": "admin@billtest255158live.ccsctp.net"  
      },  
      "createdTime": "2016-03-03T17:17:00.5490763-08:00",  
      "modifiedBy": {  
        "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
        "upn": "admin@billtest255158live.ccsctp.net"  
      },  
      "modifiedTime": "2016-03-03T17:17:00.5490763-08:00"  
    },  
    {  
      "id": "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/e44b497d-7e58-4e31-9ac5-f9d9bd97e199",  
      "name": "root1",  
      "definition": "termDefinition",  
      "stakeholders": [  
        {  
          "objectId": "bedc9058-980c-43a5-8b3b-1e7ce98b8cef",  
          "upn": "test@sample.com"  
        }  
      ],  
      "createdBy": {  
        "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
        "upn": "admin@billtest255158live.ccsctp.net"  
      },  
      "createdTime": "2016-03-03T17:15:25.6453233-08:00",  
      "modifiedBy": {  
        "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
        "upn": "admin@billtest255158live.ccsctp.net"  
      },  
      "modifiedTime": "2016-03-03T17:15:25.6453233-08:00"  
    }  
  ]  
}

获取

获取单个术语表术语。

请求

GET https://api.azuredatacatalog.com/catalogs/{catalog_name}/glossaries/{glossary_name}/terms/{term_id}?api-version={api-version}

注意

某些 HTTP 客户端实现可能会自动重新发出请求以响应来自服务器的 302，但通常会从请求中删除 Authorization 标头 。 由于向 ADC 发出请求需要授权标头，因此必须确保在向 ADC 指定的重定向位置重新发出请求时仍提供授权标头。 下面是使用 .NET HttpWebRequest 对象演示这一点的示例代码。

URI 参数

名称 说明 数据类型
catalog_name 目录的名称，或“DefaultCatalog”以使用默认目录。 String
glossary_name 术语表的名称，默认与 catalog_name 相同。 使用“DefaultGlossary”选择默认术语表。 String
term_id 术语表术语的 ID。 String
api-version API 版本。 String

GET 示例

GET https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/DefaultCatalog/glossaries/DefaultGlossary/terms/e44b497d-7e58-4e31-9ac5-f9d9bd97e199?api-version=2016-03-30

标头

x-ms-client-request-id: 8091955f…8f5b4c0acede Authorization: Bearer eXJ0eyAiOiJKV1QiLCJhbGciOi...

响应

状态代码

代码 说明
200 没问题。 响应包含请求的术语表术语。
404 NotFound。 找不到术语。

Content-Type

application/json

标头

x-ms-request-id: 1095e88c…caffabd6dabd  
Content-Type: application/json; charset=utf-8

正文

{  
  "id": "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/e44b497d-7e58-4e31-9ac5-f9d9bd97e199",  
  "name": "root1",  
  "definition": "termDefinition",  
  "description" : "some description",  
  "stakeholders": [  
    {  
      "objectId": "bedc9058-980c-43a5-8b3b-1e7ce98b8cef",  
      "upn": "holder@example.com"  
    }  
  ],  
  "createdBy": {  
    "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
    "upn": "admin@billtest255158live.ccsctp.net"  
  },  
  "createdTime": "2016-03-03T17:15:25.6453233-08:00",  
  "modifiedBy": {  
    "objectId": "03dee373-5753-49c4-88f7-68041d39cc24",  
    "upn": "admin@billtest255158live.ccsctp.net"  
  },  
  "modifiedTime": "2016-03-03T17:15:25.6453233-08:00"  
}

更新

汇报单个术语表术语。

请求

PUT https://api.azuredatacatalog.com/catalogs/{catalog_name}/glossaries/{glossary_name}/terms/{term_id}?api-version={api-version}

注意

某些 HTTP 客户端实现可能会自动重新发出请求以响应来自服务器的 302，但通常会从请求中删除 Authorization 标头 。 由于向 ADC 发出请求需要授权标头，因此必须确保在向 ADC 指定的重定向位置重新发出请求时仍提供授权标头。 下面是使用 .NET HttpWebRequest 对象演示这一点的示例代码。

URI 参数

名称 说明 数据类型
catalog_name 目录的名称，或“DefaultCatalog”以使用默认目录。 String
glossary_name 术语表的名称，默认与 catalog_name 相同。 使用“DefaultGlossary”选择默认术语表。 String
term_id 术语表术语的 ID。 String
api-version API 版本。 String

PUT 示例

PUT https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/DefaultCatalog/glossaries/DefaultGlossary/terms/b04e39a9-b457-4ab3-9da9-58b42be29577?api-version=2016-03-30

标头

Content-Type： application/json x-ms-client-request-id： 13c45c14...46ab469473f0 授权：持有者 eyJ0eX ...FWSXfwtQ

 #### 正文示例
{  
  "parentId" : "https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/e44b497d-7e58-4e31-9ac5-f9d9bd97e199"  
  "name" : "Child",  
  "definition" : "termDefinition",  
  "stakeholders" : [  
    {  
      "objectId" : "bedc9058-980c-43a5-8b3b-1e7ce98b8cef",  
      "upn" : "test@example.com"  
    }  
  ]  
}

响应

状态代码

代码 说明
200 正常。 现有术语已更新。
404 NotFound。 找不到术语。
409 冲突。 同一父术语下已存在重复的术语名称。
412 前置条件失败。 由于 ETag 不匹配，请求已取消。

Content-Type

application/json

标头

x-ms-request-id: 1095e88c…caffabd6dabd  
Location:  https://e2255231-6dd3-1a0d-a6d8-7fc96dd780c2-mycatalog.api.azuredatacatalog.com/catalogs/MyCatalog/glossaries/MyCatalog/terms/b04e39a9-b457-4ab3-9da9-58b42be29577