Share via


Wat zijn REST API's voor Reporting Services?

Van toepassing op: SQL Server Reporting Services (2017 en nieuwere versies) Niet ondersteund Power BI Report Server

Microsoft SQL Server 2017 Reporting Services ondersteunt REST-API's (Representational State Transfer). REST API's zijn service-eindpunten die ondersteuning bieden voor een set HTTP-bewerkingen (methoden). Deze methoden bieden toegang tot het maken, ophalen, bijwerken of verwijderen van resources in een rapportserver.

Een REST API biedt programmatische toegang tot de objecten in een SQL Server 2017 Reporting Services-rapportservercatalogus. Hier volgen voorbeelden van objecten:

  • Mappen
  • Rapporten
  • KPI's
  • Gegevensbronnen
  • Datasets
  • Vernieuwingsplannen
  • Abonnementen

Wanneer u een REST API gebruikt, kunt u door de maphiërarchie navigeren, de inhoud van een map detecteren of een rapportdefinitie downloaden. U kunt ook objecten maken, bijwerken en verwijderen.

Opmerking

Als u geïnteresseerd bent in het bekijken of verwijderen van persoonsgegevens, raadpleegt u de richtlijnen van Microsoft op de Windows AVG-verzoeken van betrokkenen site. Als u op zoek bent naar algemene informatie over de AVG, raadpleegt u de sectie AVG van de Service Trust-portal.

Onderdelen van een REST API-aanvraag/-antwoord

Een REST API-aanvraag-/antwoordpaar kan worden gescheiden in vijf onderdelen:

  • De aanvraag-URI:

    • Hoewel de aanvraag-URI is opgenomen in de header van het aanvraagbericht, moeten de meeste talen of frameworks deze afzonderlijk van het aanvraagbericht doorgeven.
    • {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}Bestaat uit .
    URI-aanvraag Description
    URI-schema Geeft het protocol aan dat wordt gebruikt om de aanvraag te verzenden. Een voorbeeld hiervan is http of https.
    URI host Hiermee geeft u de domeinnaam of het IP-adres van de server waarop het REST-service-eindpunt wordt gehost, zoals myserver.contoso.com.
    Resourcepad Hiermee geeft u de resource of resourceverzameling op, die meerdere segmenten kan bevatten die door de service worden gebruikt bij het bepalen van de selectie van deze resources. U kunt bijvoorbeeld CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties gebruiken om de eigenschappen opgegeven voor de CatalogItem te verkrijgen.
    Querytekenreeks (optioneel) Biedt meer eenvoudige parameters, zoals de API-versie en resource-selectiecriteria.
  • Headervelden voor HTTP-aanvraagberichten:

    • Een vereiste HTTP-methode, ook wel een bewerking of werkwoord genoemd.
    • Hiermee wordt aangegeven wat voor type bewerking u aanvraagt. Reporting Services REST API's bieden ondersteuning voor DELETE-, GET-, HEAD-, PUT-, POST- en PATCH-methoden.
    • Optionele extra headervelden, zoals vereist door de opgegeven URI en HTTP-methode.
  • Optionele hoofdtekstvelden voor HTTP-aanvraagberichten :

    • Ondersteunt de URI- en HTTP-bewerking. POST-bewerkingen bevatten bijvoorbeeld MIME-objecten (Multipurpose Internet Mail Extensions) die als complexe parameters worden doorgegeven.
    • Voor POST- of PUT-bewerkingen moet het MIME-coderingstype voor de hoofdtekst ook worden opgegeven in de Content-type aanvraagheader. Voor sommige services moet u een specifiek MIME-type gebruiken, zoals application/json.
  • Headervelden voor HTTP-antwoordberichten:

    • Een HTTP-statuscode, variërend van 2xx-succescodes tot 4xx- of 5xx-foutcodes. U kunt ook een servicegedefinieerde statuscode retourneren, zoals aangegeven in de API-documentatie.
    • Optionele extra headervelden, zoals vereist voor de ondersteuning van het antwoord van de aanvraag, zoals een Content-type antwoordheader.
  • Optionele hoofdtekstvelden voor HTTP-antwoordberichten :

    • MIME-gecodeerde antwoordobjecten worden geretourneerd in de hoofdtekst van het HTTP-antwoord, zoals een antwoord van een GET-methode die gegevens retourneert. Deze objecten worden doorgaans geretourneerd in een gestructureerde indeling, zoals JSON of XML, zoals aangegeven door de Content-type antwoordheader.

API-documentatie

Een moderne REST API-aanroep voor moderne API-documentatie. Een REST API is gebaseerd op de OpenAPI-specificatie, die ook wel de swagger-specificatie wordt genoemd. Power BI Report Server REST API-documentatie is beschikbaar op Microsoft Learn.

API-aanroepen testen

Als u een hulpprogramma nodig hebt voor het testen van HTTP-aanvraag-/antwoordberichten, is Fiddler een gratis webfoutopsporingsproxy die uw REST-aanvragen kan onderscheppen, zodat u eenvoudig de HTTP-aanvraag-/antwoordberichten kunt diagnosticeren.