Bagikan melalui

Mengembangkan dengan API REST untuk Microsoft SQL Server Reporting Services

  • Artikel

Berlaku untuk: Server Laporan Power BI SQL Server Reporting Services (2017 dan yang lebih baru) ❌

Microsoft SQL Server 2017 Reporting Services mendukung API Representational State Transfer (REST). REST API adalah titik akhir layanan yang mendukung serangkaian operasi HTTP (metode), yang menyediakan akses buat, ambil, perbarui, atau hapus untuk sumber daya dalam server laporan.

REST API menyediakan akses terprogram ke objek dalam katalog server laporan SQL Server 2017 Reporting Services. Contoh objek adalah folder, laporan, KPI, sumber data, himpunan data, paket refresh, langganan, dan lainnya. Dengan menggunakan REST API, Anda dapat, misalnya, menavigasi hierarki folder, menemukan konten folder, atau mengunduh definisi laporan. Anda juga dapat membuat, memperbarui, dan menghapus objek. Contoh bekerja dengan objek termasuk mengunggah laporan, menjalankan rencana refresh, menghapus folder, dan sebagainya.

Catatan

Jika Anda tertarik untuk melihat atau menghapus data pribadi, tinjau panduan Microsoft di Permintaan Subjek Data Windows untuk situs GDPR . Jika Anda mencari informasi umum tentang GDPR, lihat bagian GDPR di portal Kepercayaan Layanan.

Komponen permintaan/respon dari REST API

Pasangan permintaan/respons REST API dapat dipisahkan menjadi lima komponen:

  • Permintaan URI, yang terdiri atas: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}. Meskipun URI permintaan disertakan dalam header pesan permintaan, kami menyebutnya secara terpisah di sini karena sebagian besar bahasa atau kerangka kerja mengharuskan Anda untuk meneruskannya secara terpisah dari pesan permintaan.

    • Skema URI: Menunjukkan protokol yang digunakan untuk mengirimkan permintaan. Misalnya, http atau https.
    • Host URI: menentukan nama domain atau alamat IP server tempat titik akhir layanan REST dihosting, seperti myserver.contoso.com.
    • Jalur sumber daya: Menentukan kumpulan sumber daya atau sumber daya, yang mungkin mencakup beberapa segmen yang digunakan oleh layanan dalam menentukan pemilihan sumber daya tersebut. Misalnya: CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties dapat digunakan untuk mendapatkan properti yang ditentukan untuk CatalogItem.
    • String kueri (opsional): Menyediakan parameter yang lebih sederhana, seperti versi API atau kriteria pemilihan sumber daya.

  • Bidang header pesan permintaan HTTP:

    • Metode HTTP yang diperlukan (juga dikenal sebagai operasi atau kata kerja), yang memberi tahu layanan jenis operasi apa yang Anda minta. Layanan Laporan API REST mendukung metode DELETE, GET, HEAD, PUT, POST, dan PATCH.
    • Bidang header tambahan opsional, seperti yang diperlukan oleh metode URI dan HTTP yang ditentukan.

  • Bidang isi pesan permintaan HTTP opsional, untuk mendukung operasi URI dan HTTP. Misalnya, operasi POST berisi objek yang dikodekan MIME yang diteruskan sebagai parameter kompleks. Untuk operasi POST atau PUT, jenis pengodean MIME untuk isi juga harus ditentukan di header permintaan Content-type juga. Beberapa layanan mengharuskan Anda menggunakan jenis MIME tertentu, seperti application/json.

  • Bidang header pesan respons HTTP:

    • Kode status HTTP, mulai dari 2xx kode keberhasilan hingga 4xx atau 5xx kode kesalahan. Atau, kode status yang ditentukan layanan mungkin dikembalikan, seperti yang ditunjukkan dalam dokumentasi API.
    • Bidang header tambahan opsional, seperti yang diperlukan untuk mendukung respons permintaan, seperti Content-type header respons.

  • Bidang isi pesan respons HTTP opsional:

    • Objek respons yang dikodekan MIME dikembalikan dalam isi respons HTTP, seperti respons dari metode GET yang mengembalikan data. Biasanya, objek ini dikembalikan dalam format terstruktur seperti JSON atau XML, seperti yang ditunjukkan oleh Content-type header respons.

Dokumentasi API

REST API modern memanggil dokumentasi API modern. REST API dibangun berdasarkan spesifikasi OpenAPI (juga disebut spesifikasi swagger) dan dokumentasi tersedia di Microsoft Learn.

Menguji panggilan API

Alat untuk menguji pesan permintaan/respons HTTP adalah Fiddler. Fiddler adalah proksi penelusuran kesalahan web gratis yang dapat mencegat permintaan REST Anda, sehingga mudah untuk mendiagnosis pesan permintaan/respons HTTP.

Langkah berikutnya

Tinjau API yang tersedia di Microsoft Learn.

Sampel tersedia di GitHub. Sampel mencakup aplikasi HTML5 yang dibangun di TypeScript, React, dan Webpack bersama dengan contoh PowerShell.

Ada pertanyaan lagi? Coba tanyakan forum Reporting Services