Ontwikkelen met de REST API's voor Power BI Report Server

Power BI Report Server biedt ondersteuning voor REST-API's (Representational State Transfer). De REST API's zijn service-eindpunten die ondersteuning bieden voor een set HTTP-bewerkingen (methoden), die toegang bieden tot resources binnen een rapportserver, die toegang bieden tot het maken, ophalen, bijwerken of verwijderen van resources.

De REST API biedt programmatische toegang tot de objecten in een Power BI Report Server-catalogus. Voorbeelden van objecten zijn mappen, rapporten, KPI's, gegevensbronnen, gegevenssets, vernieuwingsplannen, abonnementen en meer. Met behulp van de REST API kunt u bijvoorbeeld door de maphiërarchie navigeren, de inhoud van een map detecteren of een rapportdefinitie downloaden. U kunt ook objecten maken, bijwerken en verwijderen. Voorbeelden van het werken met objecten zijn het uploaden van een rapport, het uitvoeren van een vernieuwingsplan, het verwijderen van een map enzovoort.

Notitie

Als u persoonsgegevens wilt bekijken of verwijderen, raadpleegt u de richtlijnen van Microsoft in de Verzoeken van betrokkenen van Windows voor de AVG-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, die bestaat uit: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}. Hoewel de aanvraag-URI is opgenomen in de header van het aanvraagbericht, noemen we deze hier afzonderlijk, omdat voor de meeste talen of frameworks u deze afzonderlijk van het aanvraagbericht moet doorgeven.

  • URI-schema: geeft het protocol aan dat wordt gebruikt om de aanvraag te verzenden. Bijvoorbeeld 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. Bijvoorbeeld: CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties kan worden gebruikt om de opgegeven eigenschappen voor de CatalogItem op te halen.
  • Querytekenreeks (optioneel): biedt aanvullende eenvoudige parameters, zoals de API-versie of resourceselectiecriteria.

• Headervelden voor HTTP-aanvraagberichten:

  • Een vereiste HTTP-methode (ook wel een bewerking of werkwoord genoemd), waarmee de service aangeeft welk 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 ter ondersteuning van de URI- en HTTP-bewerking. POST-bewerkingen bevatten bijvoorbeeld DOOR MIME gecodeerde objecten 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. De REST API is gebaseerd op de OpenAPI-specificatie (a.k.a. de swagger-specificatie) en documentatie is beschikbaar op Microsoft Learn.

API-aanroepen testen

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

Gerelateerde inhoud

Bekijk de beschikbare API's op Microsoft Learn.

Voorbeelden zijn beschikbaar op GitHub. Het voorbeeld bevat een HTML5-app die is gebouwd op TypeScript, React en webpack, samen met een PowerShell-voorbeeld.

Meer vragen? Vraag het Power BI-community