共用方式為

詞彙 (Azure 資料目錄 REST API)

  • 發行項

建立

建立單一詞彙。

要求

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

注意

某些 HTTP 用戶端實作可能會自動重新發出要求，以回應來自伺服器的 302，但通常會從要求移除 授權標頭 。 由於授權標頭需要向 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 已建立。 要求已完成，並已建立新的字詞。
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，但通常會從要求移除 授權標頭 。 由於授權標頭需要向 ADC 提出要求，因此您必須確保授權標頭仍會在重新發出要求給 ADC 所指定的重新導向位置時提供。 以下是使用 .NET HttpWebRequest 物件示範此專案的範例程式碼。

URI 參數

名稱 描述 資料類型
catalog_name 目錄的名稱，或 「DefaultCatalog」 以使用預設目錄。 String
glossary_name 詞彙的名稱，預設為與catalog_name相同。 使用 「DefaultGlossary」 來選擇預設詞彙。 String
term_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 不符，所以要求已取消。

注意

刪除作業語意為「如果有的話刪除」，因此如果字詞不存在成功狀態碼 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，但通常會從要求移除 授權標頭 。 由於授權標頭需要向 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

取得單一詞彙。

要求

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

注意

某些 HTTP 用戶端實作可能會自動重新發出要求，以回應來自伺服器的 302，但通常會從要求移除 授權標頭 。 由於需要 Authorization 標頭才能對 ADC 提出要求，因此您必須確保將要求重新發出至 ADC 所指定的重新導向位置時，仍會提供 Authorization 標頭。 以下是使用 .NET HttpWebRequest 物件示範此範例的程式碼。

URI 參數

名稱 描述 資料類型
catalog_name 目錄的名稱，或 「DefaultCatalog」 以使用預設目錄。 String
glossary_name 字彙的名稱，預設為與catalog_name相同。 使用 「DefaultGlossary」 來選擇預設詞彙。 String
term_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 所指定的重新導向位置時，仍會提供 Authorization 標頭。 以下是使用 .NET HttpWebRequest 物件示範此範例的程式碼。

URI 參數

名稱 描述 資料類型
catalog_name 目錄的名稱，或 「DefaultCatalog」 以使用預設目錄。 String
glossary_name 字彙的名稱，預設為與catalog_name相同。 使用 「DefaultGlossary」 來選擇預設詞彙。 String
term_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 Authorization： Bearer eyJ0eX ...FWSXfwtQ

 #### Body 範例
{  
  "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