Bagikan melalui

Glosarium (Azure Data Catalog REST API)

  • Artikel

Buat

Membuat satu istilah glosarium.

Minta

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

Catatan

Beberapa implementasi klien HTTP dapat secara otomatis mengeluarkan ulang permintaan sebagai respons terhadap 302 dari server, tetapi biasanya menghapus header Otorisasi dari permintaan. Karena header Otorisasi diperlukan untuk membuat permintaan ke ADC, Anda harus memastikan header Otorisasi masih disediakan saat mengeluarkan kembali permintaan ke lokasi pengalihan yang ditentukan oleh ADC. Di bawah ini adalah contoh kode yang menunjukkan ini menggunakan objek .NET HttpWebRequest.

Parameter Uri

Nama Deskripsi Jenis Data
catalog_name Nama katalog, atau "DefaultCatalog" untuk menggunakan katalog default. String
glossary_name Nama glosarium, yang defaultnya sama dengan catalog_name. Gunakan "DefaultGlossary" untuk memilih glosarium default. String
versi-api Versi API. String

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

Catatan:

  1. Jika isi tidak menyertakan "parentId", istilah yang dibuat akan menjadi istilah akar dan tidak memiliki induk.
  2. Dua istilah tidak diizinkan untuk memiliki nama yang sama jika mereka memiliki istilah induk yang sama.

Respons

Kode status

Kode Deskripsi
201 Dibuat. Permintaan terpenuhi dan istilah baru dibuat.
409 Konflik. Nama istilah duplikat sudah ada di bawah istilah induk yang sama.

Jenis-Konten

application/json

Header

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

Hapus

Menghapus satu istilah glosarium.

Minta

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

Catatan

Beberapa implementasi klien HTTP dapat secara otomatis mengeluarkan ulang permintaan sebagai respons terhadap 302 dari server, tetapi biasanya menghapus header Otorisasi dari permintaan. Karena header Otorisasi diperlukan untuk membuat permintaan ke ADC, Anda harus memastikan header Otorisasi masih disediakan saat mengeluarkan kembali permintaan ke lokasi pengalihan yang ditentukan oleh ADC. Di bawah ini adalah contoh kode yang menunjukkan ini menggunakan objek .NET HttpWebRequest.

Parameter Uri

Nama Deskripsi Jenis Data
catalog_name Nama katalog, atau "DefaultCatalog" untuk menggunakan katalog default. String
glossary_name Nama glosarium, yang defaultnya sama dengan catalog_name. Gunakan "DefaultGlossary" untuk memilih glosarium default. String
term_id ID istilah glosarium. String
versi-api Versi API. String

Contoh 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

Header

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

Respons

Kode status

Kode Deskripsi
204 NoContent. Istilah tidak ada atau penghapusan berhasil.
404 BukanFound. Istilah tidak ditemukan.
412 Prasyarat Gagal. Permintaan dibatalkan karena ketidakcocokan ETag.

Catatan

Semantik operasi Hapus adalah "hapus jika ada", jadi jika istilah tidak ada kode status keberhasilan 204 (NoContent) akan dikembalikan.

Jenis-Konten

application/json

Header

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

Menghitung

Hitung semua istilah dalam glosarium.

Minta

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

Catatan

Beberapa implementasi klien HTTP dapat secara otomatis mengeluarkan ulang permintaan sebagai respons terhadap 302 dari server, tetapi biasanya menghapus header Otorisasi dari permintaan. Karena header Otorisasi diperlukan untuk membuat permintaan ke ADC, Anda harus memastikan header Otorisasi masih disediakan saat mengeluarkan kembali permintaan ke lokasi pengalihan yang ditentukan oleh ADC. Di bawah ini adalah contoh kode yang menunjukkan ini menggunakan objek .NET HttpWebRequest.

Parameter Uri

Nama Deskripsi Jenis Data
catalog_name Nama katalog, atau "DefaultCatalog" untuk menggunakan katalog default. String
glossary_name Nama glosarium, yang defaultnya sama dengan catalog_name. Gunakan "DefaultGlossary" untuk memilih glosarium default. String
versi-api Versi API. String

Contoh GET

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

Header

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

Respons

Kode status

Kode Deskripsi
200 OK. Respons berisi daftar istilah glosarium.

Jenis-Konten

application/json

Header

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

Isi

Catatan

Setiap operasi enumerasi mengembalikan paling banyak 1000 istilah. Jika ada lebih dari 1000 istilah dalam glosarium, "nextLink" akan disertakan dalam respons untuk enumerasi berkelanjutan.

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

Dapatkan

Mendapatkan satu istilah glosarium.

Minta

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

Catatan

Beberapa implementasi klien HTTP dapat secara otomatis mengeluarkan ulang permintaan sebagai respons terhadap 302 dari server, tetapi biasanya menghapus header Otorisasi dari permintaan. Karena header Otorisasi diperlukan untuk membuat permintaan ke ADC, Anda harus memastikan header Otorisasi masih disediakan saat mengeluarkan kembali permintaan ke lokasi pengalihan yang ditentukan oleh ADC. Di bawah ini adalah contoh kode yang menunjukkan ini menggunakan objek .NET HttpWebRequest.

Parameter Uri

Nama Deskripsi Jenis Data
catalog_name Nama katalog, atau "DefaultCatalog" untuk menggunakan katalog default. String
glossary_name Nama glosarium, yang defaultnya sama dengan catalog_name. Gunakan "DefaultGlossary" untuk memilih glosarium default. String
term_id ID istilah glosarium. String
versi-api Versi API. String

Contoh 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

Header

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

Respons

Kode status

Kode Deskripsi
200 OK. Respons berisi istilah glosarium yang diminta.
404 BukanFound. Istilah tidak ditemukan.

Jenis-Konten

application/json

Header

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

Isi

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

Pembaruan

Updates satu istilah glosarium.

Minta

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

Catatan

Beberapa implementasi klien HTTP dapat secara otomatis mengeluarkan ulang permintaan sebagai respons terhadap 302 dari server, tetapi biasanya menghapus header Otorisasi dari permintaan. Karena header Otorisasi diperlukan untuk membuat permintaan ke ADC, Anda harus memastikan header Otorisasi masih disediakan saat mengeluarkan kembali permintaan ke lokasi pengalihan yang ditentukan oleh ADC. Di bawah ini adalah contoh kode yang menunjukkan ini menggunakan objek .NET HttpWebRequest.

Parameter Uri

Nama Deskripsi Jenis Data
catalog_name Nama katalog, atau "DefaultCatalog" untuk menggunakan katalog default. String
glossary_name Nama glosarium, yang defaultnya sama dengan catalog_name. Gunakan "DefaultGlossary" untuk memilih glosarium default. String
term_id ID istilah glosarium. String
versi-api Versi API. String

Contoh 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

Header

Jenis Konten: application/json x-ms-client-request-id: 13c45c14... 46ab469473f0 Otorisasi: Pembawa eyJ0eX ... FWSXfwtQ

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

Respons

Kode status

Kode Deskripsi
200 Oke. Istilah yang ada telah diperbarui.
404 BukanFound. Istilah tidak ditemukan.
409 Konflik. Nama istilah duplikat sudah ada di bawah istilah induk yang sama.
412 Prasyarat Gagal. Permintaan dibatalkan karena ketidakcocokan ETag.

Jenis-Konten

application/json

Header

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