用語集 (Azure Data Catalog REST API)

  • [アーティクル]

作成

1 つの用語集の用語を作成します。

Request

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

Note

一部の HTTP クライアント実装では、サーバーからの 302 に応答して要求を自動的に再発行できますが、通常は 要求から Authorization ヘッダー を取り除きます。 ADC に要求を行うには Authorization ヘッダーが必要であるため、ADC で指定されたリダイレクト場所に要求を再発行する場合は、Authorization ヘッダーが引き続き提供されていることを確認する必要があります。 .NET HttpWebRequest オブジェクトを使用してこれを示すサンプル コードを次に示します。

URI パラメーター

名前 説明 データ型
catalog_name カタログの名前。既定のカタログを使用する場合は "DefaultCatalog" です。 String
glossary_name 用語集の名前。既定値はcatalog_nameと同じです。 "既定の用語集" を使用して、既定の用語集を選択します。 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. 2 つの用語が同じ親用語を持つ場合、同じ名前を持つことは許可されません。

Response

状態コード

コード 説明
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

削除

1 つの用語集の用語を削除します。

Request

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

Note

一部の HTTP クライアント実装では、サーバーからの 302 に応答して要求を自動的に再発行できますが、通常は 要求から Authorization ヘッダー を取り除きます。 ADC に要求を行うには Authorization ヘッダーが必要であるため、ADC で指定されたリダイレクト場所に要求を再発行する場合は、Authorization ヘッダーが引き続き提供されていることを確認する必要があります。 .NET HttpWebRequest オブジェクトを使用してこれを示すサンプル コードを次に示します。

URI パラメーター

名前 説明 データ型
catalog_name カタログの名前。既定のカタログを使用する場合は "DefaultCatalog" です。 String
glossary_name 用語集の名前。既定値はcatalog_nameと同じです。 "既定の用語集" を使用して、既定の用語集を選択します。 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...

Response

状態コード

コード 説明
204 NoContent。 用語が存在しないか、削除が成功しました。
404 NotFound。 用語が見つかりません。
412 前提条件に失敗しました。 ETag の不一致が原因で要求が取り消されました。

注意

Delete 操作セマンティックは "存在する場合は削除" であるため、用語が存在しない場合は成功状態コード 204 (NoContent) が返されます。

Content-Type

application/json

ヘッダー

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

[列挙]

用語集内のすべての用語を列挙します。

Request

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

Note

一部の HTTP クライアント実装では、サーバーからの 302 に応答して要求を自動的に再発行できますが、通常は 要求から Authorization ヘッダー を取り除きます。 ADC に要求を行うには Authorization ヘッダーが必要であるため、ADC で指定されたリダイレクト場所に要求を再発行する場合は、Authorization ヘッダーが引き続き提供されていることを確認する必要があります。 .NET HttpWebRequest オブジェクトを使用してこれを示すサンプル コードを次に示します。

URI パラメーター

名前 説明 データ型
catalog_name カタログの名前。既定のカタログを使用する場合は "DefaultCatalog" です。 String
glossary_name 用語集の名前。既定値はcatalog_nameと同じです。 既定の用語集を選択するには、"既定の用語集" を使用します。 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...

Response

状態コード

コード 説明
200 OK です。 応答には、用語集の用語の一覧が含まれています。

Content-Type

application/json

ヘッダー

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

Body

注意

各列挙操作は、最大 1,000 個の用語を返します。 用語集に 1,000 を超える用語がある場合は、連続列挙の応答に "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"  
    }  
  ]  
}

取得

1 つの用語集の用語を取得します。

Request

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

Note

一部の HTTP クライアント実装では、サーバーからの 302 に応答して要求を自動的に再発行できますが、通常は 要求から Authorization ヘッダー を削除します。 ADC に要求を行うには Authorization ヘッダーが必要であるため、ADC で指定されたリダイレクト場所に要求を再発行するときに、Authorization ヘッダーが引き続き提供されていることを確認する必要があります。 .NET HttpWebRequest オブジェクトを使用してこれを示すサンプル コードを次に示します。

URI パラメーター

名前 説明 データ型
catalog_name カタログの名前。既定のカタログを使用する "DefaultCatalog" です。 String
glossary_name 用語集の名前。既定値はcatalog_nameと同じです。 既定の用語集を選択するには、"既定の用語集" を使用します。 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...

Response

状態コード

コード 説明
200 OK です。 応答には、要求された用語集の用語が含まれています。
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"  
}

更新

1 つの用語集の用語を更新します。

Request

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

Note

一部の HTTP クライアント実装では、サーバーからの 302 に応答して要求を自動的に再発行できますが、通常は 要求から Authorization ヘッダー を削除します。 ADC に要求を行うには Authorization ヘッダーが必要であるため、ADC で指定されたリダイレクト場所に要求を再発行するときに、Authorization ヘッダーが引き続き提供されていることを確認する必要があります。 .NET HttpWebRequest オブジェクトを使用してこれを示すサンプル コードを次に示します。

URI パラメーター

名前 説明 データ型
catalog_name カタログの名前。既定のカタログを使用する "DefaultCatalog" です。 String
glossary_name 用語集の名前。既定値はcatalog_nameと同じです。 既定の用語集を選択するには、"既定の用語集" を使用します。 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 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"  
    }  
  ]  
}

Response

状態コード

コード 説明
200 OK 既存の用語が更新されました。
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