Freigeben über

Was sind REST-APIs für Reporting Services?

  • Artikel

Gilt für: SQL Server Reporting Services (2017 und höher) ❌ Power BI-Berichtsserver

Microsoft SQL Server 2017 Reporting Services unterstützen Representational State Transfer-APIs (REST). REST-APIs sind Dienstendpunkte, die eine Reihe von HTTP-Vorgängen (Methoden) unterstützen. Diese Methoden ermöglichen den Zugang zum Erstellen, Abrufen, Aktualisieren oder Löschen von Ressourcen innerhalb eines Berichtsservers.

Eine REST-API stellt programmgesteuerten Zugriff auf die Objekte in einem SQL Server 2017 Reporting Services-Berichtsserverkatalog bereit. Im Folgenden sind Beispiele für Objekte aufgeführt:

  • Ordner
  • Berichte
  • KPIs
  • Datenquellen
  • Datasets
  • Pläne aktualisieren
  • Abonnements

Wenn Sie eine REST-API verwenden, können Sie in der Ordnerhierarchie navigieren, den Inhalt eines Ordners ermitteln oder eine Berichtsdefinition herunterladen. Außerdem können Sie Objekte erstellen, aktualisieren und löschen.

Hinweis

Informationen zum Anzeigen und Löschen von personenbezogenen Daten finden Sie im Leitfaden von Microsoft auf der Website zu den Windows-Datensubjektanforderungen für die DSGVO. Allgemeine Informationen über die DSGVO finden Sie im Abschnitt zur DSGVO im Service Trust-Portal.

Komponenten einer REST-API-Anforderung/Antwort

Ein REST-API-Anforderung/Antwort-Paar kann in fünf Komponenten gegliedert werden:

  • Der Anforderungs-URI:

    • Obwohl der Header der Anforderungsnachricht den Anforderungs-URI enthält, da es für viele Sprachen und Frameworks erforderlich ist, diesen separat der Anforderungsnachricht zu entnehmen.
    • Besteht aus {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}.
    Anforderungs-URI Beschreibung
    URI-Schema Gibt das Protokoll an, das zum Übertragen der Anforderung verwendet wird. Zum Beispiel: http oder https.
    URI-Host Gibt den Domänennamen oder die IP-Adresse des Servers an, auf dem der REST-Dienstendpunkt gehostet wird. Zum Beispiel: myserver.contoso.com.
    Resource path Gibt die Ressource oder die Ressourcenauflistung an, die möglicherweise mehrere Segmente enthält, die vom Dienst zur Bestimmung der Auswahl dieser Ressourcen verwendet werden. Sie können zum Beispiel CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties verwenden, um die angegebenen Eigenschaften für CatalogItem zu erhalten.
    Abfragezeichenfolge (optional) Stellt zusätzliche, einfache Parameter wie die API-Version oder die Kriterien der Ressourcenauswahl bereit.

  • Headerfelder für HTTP-Anforderungsnachrichten:

    • Eine erforderliche HTTP-Methode, auch als Vorgang oder Verb bezeichnet.
    • Gibt dem Dienst an, um welche Art von Operation Sie bitten. Reporting Services REST-APIs unterstützen die Methoden DELETE, GET, HEAD, PUT, POST und PATCH (Löschen, Abrufen, Kopfteil, Platzieren, Bereitstellen und Reparieren).
    • Zusätzliche optionale Headerfelder, die für den angegebenen URI und HTTP-Methode erforderlich sind.

  • Optionale Felder des HTTP-Anfragetextes:

    • Unterstützt den URI- und HTTP-Vorgang. POST-Operationen enthalten zum Beispiel MIME-kodierte Objekte, die als komplexe Parameter übergeben werden.
    • Für POST- oder PUT-Vorgänge sollte der MIME-codierte Textkörpertyp ebenfalls im Anforderungsheader Content-type angegeben werden. Einige Dienste verlangen die Verwendung eines MIME-Typs wie application/json.

  • Nachrichtenheaderfelder mit HTTP-Anworten:

    • Ein HTTP-Statuscode, der zwischen den Erfolgscodes 2xx und den Fehlercodes 4xx oder 5xx liegt. Stattdessen kann auch, wie in der API-Dokumentation angegeben, ein Statuscode zurückgegeben werden, der für einen Dienst definiert ist.
    • Zusätzliche optionale Headerfelder, die zum Unterstützen der Antwort der Anforderung erforderlich sind, z.B. ein Content-type-Antwortheader.

  • Optionale Nachrichtentextfelder mit HTTP-Antworten:

    • MIME-codierte Antwortobjekte werden im HTTP-Antworttext zurückgegeben, wie z.B. eine Antwort von einer GET-Methode, die Daten zurückgibt. Für gewöhnlich werden diese Objekte in einem strukturierten Format wie JSON oder XML zurückgegeben, wie im Content-type-Antwortheader angegeben.

API-Dokumentation

Eine moderne REST-API benötigt auch eine moderne API-Dokumentation. Eine REST-API basiert auf der OpenAPI-Spezifikation, die auch als Swagger-Spezifikation bezeichnet wird. Power BI-Berichtsserver REST-API-Dokumentation ist in Microsoft Learn verfügbar.

REST-API-Aufrufe

Wenn Sie ein Tool zum Testen von HTTP-Anfrage/Antwort-Nachrichten benötigen, ist Fiddler ein kostenloser Web-Debugging-Proxy, der Ihre REST-Anfragen abfangen kann und die Diagnose der HTTP-Anfrage/Antwort-Nachrichten erleichtert.

Zugehöriger Inhalt