Aracılığıyla paylaş

Sözlük (Azure Veri Kataloğu REST API)

  • Makale

Oluştur

Tek bir sözlük terimi oluşturur.

İstek

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

Not

Bazı HTTP istemci uygulamaları, sunucudan bir 302'ye yanıt olarak istekleri otomatik olarak yeniden verebilir, ancak genellikle istekten Yetkilendirme üst bilgilerini ayırır. ADC'ye istekte bulunmak için Yetkilendirme üst bilgisi gerektiğinden, ADC tarafından belirtilen yeniden yönlendirme konumuna bir istek yeniden verilirken Yetkilendirme üst bilgisinin hala sağlandığından emin olmanız gerekir. Aşağıda .NET HttpWebRequest nesnesini kullanarak bunu gösteren örnek kod verilmiştir.

Uri parametreleri

Ad Açıklama Veri Türü
Catalog_name Kataloğun adı veya varsayılan kataloğu kullanmak için "DefaultCatalog". Dize
glossary_name Varsayılan olarak catalog_name ile aynı olan sözlüğün adı. Varsayılan sözlüğü seçmek için "DefaultGlossary" kullanın. Dize
api-sürümü API sürümü. Dize

POST örneği

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
#### Gövde örneği
{  
  "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"  
    }  
  ]  
}

Not:

  1. Gövde "parentId" içermiyorsa, oluşturulan terim kök terim olur ve üst öğe içermez.
  2. Aynı üst terime sahipse iki terimin aynı ada sahip olması yasaktır.

Yanıt

Durum kodları

Kod Description
201 Oluşturulan. İstek yerine getirildi ve yeni bir terim oluşturuldu.
409 Çakışma. Yinelenen terim adı aynı üst terim altında zaten var.

İçerik Türü

application/json

Üst bilgi

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

Sil

Tek bir sözlük terimini siler.

İstek

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

Not

Bazı HTTP istemci uygulamaları, sunucudan bir 302'ye yanıt olarak istekleri otomatik olarak yeniden verebilir, ancak genellikle istekten Yetkilendirme üst bilgilerini ayırır. ADC'ye istekte bulunmak için Yetkilendirme üst bilgisi gerektiğinden, ADC tarafından belirtilen yeniden yönlendirme konumuna bir istek yeniden verilirken Yetkilendirme üst bilgisinin hala sağlandığından emin olmanız gerekir. Aşağıda .NET HttpWebRequest nesnesini kullanarak bunu gösteren örnek kod verilmiştir.

Uri parametreleri

Ad Açıklama Veri Türü
Catalog_name Kataloğun adı veya varsayılan kataloğu kullanmak için "DefaultCatalog". Dize
glossary_name Varsayılan olarak catalog_name ile aynı olan sözlüğün adı. Varsayılan sözlüğü seçmek için "DefaultGlossary" kullanın. Dize
term_id Sözlük teriminin kimliği. Dize
api-sürümü API sürümü. Dize

DELETE örneği

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

Üst bilgi

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

Yanıt

Durum kodları

Kod Description
204 NoContent. Terim yok veya silme işlemi başarılı oldu.
404 NotFound. Terim bulunamadı.
412 Önkoşul Başarısız oldu. ETag uyuşmazlığı nedeniyle istek iptal edildi.

Not

Silme işlemi semantiği "varsa sil" şeklindedir, dolayısıyla terim yoksa başarı durum kodu 204 (NoContent) döndürülür.

İçerik Türü

application/json

Üst bilgi

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

Numaralandır

Sözlükteki tüm terimleri listeleme.

İstek

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

Not

Bazı HTTP istemci uygulamaları, sunucudan bir 302'ye yanıt olarak istekleri otomatik olarak yeniden verebilir, ancak genellikle istekten Yetkilendirme üst bilgilerini ayırır. ADC'ye istekte bulunmak için Yetkilendirme üst bilgisi gerektiğinden, ADC tarafından belirtilen yeniden yönlendirme konumuna bir istek yeniden verilirken Yetkilendirme üst bilgisinin hala sağlandığından emin olmanız gerekir. Aşağıda .NET HttpWebRequest nesnesini kullanarak bunu gösteren örnek kod verilmiştir.

Uri parametreleri

Ad Açıklama Veri Türü
Catalog_name Kataloğun adı veya varsayılan kataloğu kullanmak için "DefaultCatalog". Dize
glossary_name Varsayılan olarak catalog_name ile aynı olan sözlüğün adı. Varsayılan sözlüğü seçmek için "DefaultGlossary" kullanın. Dize
api-sürümü API sürümü. Dize

GET örneği

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

Üst bilgi

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

Yanıt

Durum kodları

Kod Description
200 Tamam ögesini seçin. Yanıt, sözlük terimlerinin listesini içerir.

İçerik Türü

application/json

Üst bilgi

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

Gövde

Not

Her numaralandırma işlemi en fazla 1000 terim döndürür. Sözlükte 1000'den fazla terim varsa, sürekli numaralandırma yanıtına bir "nextLink" eklenir.

{  
  "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"  
    }  
  ]  
}

Al

Tek bir sözlük terimi alır.

İstek

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

Not

Bazı HTTP istemci uygulamaları, sunucudan bir 302'ye yanıt olarak istekleri otomatik olarak yeniden verebilir, ancak genellikle istekten Yetkilendirme üst bilgilerini ayırır. ADC'ye istekte bulunmak için Yetkilendirme üst bilgisi gerektiğinden, ADC tarafından belirtilen yeniden yönlendirme konumuna bir istek yeniden verilirken Yetkilendirme üst bilgisinin hala sağlandığından emin olmanız gerekir. Aşağıda .NET HttpWebRequest nesnesini kullanarak bunu gösteren örnek kod verilmiştir.

Uri parametreleri

Ad Açıklama Veri Türü
Catalog_name Kataloğun adı veya varsayılan kataloğu kullanmak için "DefaultCatalog". Dize
glossary_name Varsayılan olarak catalog_name ile aynı olan sözlüğün adı. Varsayılan sözlüğü seçmek için "DefaultGlossary" kullanın. Dize
term_id Sözlük teriminin kimliği. Dize
api-sürümü API sürümü. Dize

GET örneği

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

Üst bilgi

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

Yanıt

Durum kodları

Kod Description
200 Tamam ögesini seçin. Yanıt istenen sözlük terimini içerir.
404 NotFound. Terim bulunamadı.

İçerik Türü

application/json

Üst bilgi

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

Gövde

{  
  "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"  
}

Güncelleştir

Tek bir sözlük terimi Güncelleştirmeler.

İstek

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

Not

Bazı HTTP istemci uygulamaları, sunucudan bir 302'ye yanıt olarak istekleri otomatik olarak yeniden verebilir, ancak genellikle istekten Yetkilendirme üst bilgilerini ayırır. ADC'ye istekte bulunmak için Yetkilendirme üst bilgisi gerektiğinden, ADC tarafından belirtilen yeniden yönlendirme konumuna bir istek yeniden verilirken Yetkilendirme üst bilgisinin hala sağlandığından emin olmanız gerekir. Aşağıda .NET HttpWebRequest nesnesini kullanarak bunu gösteren örnek kod verilmiştir.

Uri parametreleri

Ad Açıklama Veri Türü
Catalog_name Kataloğun adı veya varsayılan kataloğu kullanmak için "DefaultCatalog". Dize
glossary_name Varsayılan olarak catalog_name ile aynı olan sözlüğün adı. Varsayılan sözlüğü seçmek için "DefaultGlossary" kullanın. Dize
term_id Sözlük teriminin kimliği. Dize
api-sürümü API sürümü. Dize

PUT örneği

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

Üst bilgi

İçerik Türü: application/json x-ms-client-request-id: 13c45c14... 46ab469473f0 Yetkilendirme: Taşıyıcı eyJ0eX ... FWSXfwtQ

 #### Gövde örneği
{  
  "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"  
    }  
  ]  
}

Yanıt

Durum kodları

Kod Description
200 Tamam. Mevcut bir terim güncelleştirildi.
404 NotFound. Terim bulunamadı.
409 Çakışma. Yinelenen terim adı aynı üst terim altında zaten var.
412 Önkoşul Başarısız Oldu. ETag uyuşmazlığı nedeniyle istek iptal edildi.

İçerik Türü

application/json

Üst bilgi

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