Aracılığıyla paylaş

Reporting Services için REST API'leri nedir?

Şunlar için geçerlidir: SQL Server Reporting Services (2017 ve sonraki sürümler) Power BI Rapor Sunucusu desteklenmiyor

Microsoft SQL Server 2017 Reporting Services, Temsili Durum Aktarımı (REST) API'lerini destekler. REST API'leri, bir dizi HTTP işlemlerini (yöntemler) destekleyen hizmet uç noktalarıdır. Bu yöntemler bir rapor sunucusundaki kaynaklar için oluşturma, alma, güncelleştirme veya silme erişimi sağlar.

REST API, SQL Server 2017 Reporting Services rapor sunucusu kataloğundaki nesnelere program aracılığıyla erişim sağlar. Nesnelere örnekler aşağıda verilmiştir:

  • Klasörler
  • Reports
  • KPI'ler
  • Veri kaynakları
  • Veri Setleri
  • Planları yenileme
  • Abonelik

REST API kullandığınızda, klasör hiyerarşisinde gezinebilir, bir klasörün içeriğini bulabilir veya bir rapor tanımı indirebilirsiniz. Ayrıca nesneleri oluşturabilir, güncelleştirebilir ve silebilirsiniz.

Uyarı

Kişisel verileri görüntülemek veya silmek istiyorsanız, GDPR için Windows Veri Sahibi İstekleri sitesinde Microsoft'un kılavuzunu gözden geçirin. GDPR hakkında genel bilgi arıyorsanız Hizmet Güveni portalının GDPR bölümüne bakın.

REST API isteğinin/yanıtının bileşenleri

REST API isteği/yanıt çifti beş bileşene ayrılabilir:

  • İstek URI'si:

    • İstek URI'si istek iletisi üst bilgisine dahil olsa da, çoğu dil veya çerçeve bunu istek iletisinden ayrı olarak geçirmenizi gerektirir.
    • öğesinin oluşur {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}.
    İstenilen URI Description
    URI düzeni İsteği iletmek için kullanılan protokolü gösterir. Örneğin, http veya https.
    URI konağı REST hizmet uç noktasının barındırıldığı sunucunun etki alanı adını veya IP adresini belirtir, örneğin myserver.contoso.com.
    Kaynak yolu Hizmet tarafından bu kaynakların seçimini belirlerken kullanılan birden çok kesimi içerebilen kaynağı veya kaynak koleksiyonunu belirtir. Örneğin, öğesinin belirtilen özelliklerini almak için CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/PropertieskullanabilirsinizCatalogItem.
    Sorgu dizesi (isteğe bağlı) API sürümü veya kaynak seçim ölçütleri gibi daha basit parametreler sağlar.

  • HTTP isteği ileti üst bilgisi alanları:

    • İşlem veya fiil olarak da bilinen gerekli bir HTTP yöntemi.
    • Hizmete ne tür bir işlem istediğinizi bildirir. Reporting Services REST API'leri DELETE, GET, HEAD, PUT, POST ve PATCH yöntemlerini destekler.
    • Belirtilen URI ve HTTP yönteminin gerektirdiği şekilde isteğe bağlı ek üst bilgi alanları.

  • İsteğe bağlı HTTP isteği ileti gövdesi alanları:

    • URI ve HTTP işlemini destekler. Örneğin, POST işlemleri, karmaşık parametreler olarak geçirilen Çok Amaçlı İnternet Posta Uzantıları (MIME) ile kodlanmış nesneler içerir.
    • POST veya PUT işlemleri için, gövde için MIME kodlama türü de istek üst bilgisinde Content-type belirtilmelidir. Bazı hizmetler, gibi application/jsonbelirli bir MIME türünü kullanmanızı gerektirir.

  • HTTP yanıt iletisi üst bilgisi alanları:

    • 2xx başarı kodlarından 4xx veya 5xx hata kodlarına kadar değişen bir HTTP durum kodu. Alternatif olarak, API belgelerinde belirtildiği gibi hizmet tanımlı durum kodu döndürülebilir.
    • İsteğin yanıtını desteklemek için gereken isteğe bağlı ek üst bilgi alanları (örneğin, yanıt Content-type üst bilgisi).

  • İsteğe bağlı HTTP yanıt mesajı gövdesi özellikleri:

    • MIME ile kodlanmış yanıt nesneleri, veri döndüren bir GET yönteminden gelen yanıt gibi HTTP yanıt gövdesinde döndürülür. Bu nesneler genellikle yanıt üst bilgisinde gösterildiği Content-type gibi JSON veya XML gibi yapılandırılmış bir biçimde döndürülür.

API belgeleri

Modern bir REST API, modern API belgelerini gerektirir. Bir REST API, swagger spesifikasyonu olarak da adlandırılan OpenAPI spesifikasyonu üzerinde oluşturulur. Power BI Rapor Sunucusu REST API belgeleri Microsoft Learn'de mevcuttur.

API çağrılarını test edin

HTTP isteği/yanıt iletilerini test etmek için bir araca ihtiyacınız varsa Fiddler , REST isteklerinizi kesebilen ve HTTP isteği/yanıt iletilerini tanılamayı kolaylaştıran ücretsiz bir web hata ayıklama ara sunucusudur.

İlgili içerik

  • Last updated on