Udvikl med REST API'erne til Power BI Report Server

Power BI Report Server understøtter Representational State Transfer (REST) API'er. REST-API'erne er serviceendepunkter, der understøtter et sæt HTTP-operationer (metoder), som giver adgang til oprettelse, hentning, opdatering eller sletning af ressourcer inden for en rapportserver.

REST API'en giver programmatisk adgang til objekterne i et Power BI Report Server-katalog. Eksempler på objekter er mapper, rapporter, KPI'er, datakilder, datasæt, opdateringsplaner, abonnementer og mere. Ved at bruge REST API'en kan du for eksempel navigere i mappehierarkiet, opdage indholdet af en mappe eller downloade en rapportdefinition. Du kan også oprette, opdatere og slette objekter. Eksempler på at arbejde med objekter er upload af en rapport, udførelse af en opdateringsplan, sletning af en mappe og så videre.

Notat

Hvis du er interesseret i at få vist eller slette personlige data, skal du gennemse Microsofts vejledning på Webstedet Windows Data Subject Requests for the GDPR . Hvis du leder efter generelle oplysninger om GDPR, kan du se afsnittet om GDPR på Service Trust Portal.

Komponenter i en REST API-anmodning/-svar

Et REST API-anmodnings-/svarpar kan opdeles i fem komponenter:

• Anmodnings-URI, som består af: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}. Selvom anmodnings-URI'en er inkluderet i anmodningsbeskedens header, kalder vi den separat her, fordi de fleste sprog eller frameworks kræver, at du sender den separat fra anmodningsbeskeden.

  • URI-skema: Angiver protokollen, der blev brugt til at sende anmodningen. For eksempel http eller https.
  • URI-vært: Angiver domænenavnet eller IP-adressen på serveren, hvor REST-service-endpointet hostes, såsom myserver.contoso.com.
  • Ressourcesti: Angiver ressourcen eller ressourceindsamlingen, som kan inkludere flere segmenter, som tjenesten bruger til at bestemme udvælgelsen af disse ressourcer. For eksempel: CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties kan bruges til at hente de specificerede egenskaber for CatalogItem.
  • Forespørgselsstreng (valgfrit): Giver andre simple parametre, såsom API-versionen eller ressourcevalgskriterier.

• HTTP-anmodningsbeskedheaderfelter:

  • En påkrævet HTTP-metode (også kendt som en operation eller verbum), som fortæller tjenesten, hvilken type operation du anmoder om. Reporting Services REST API'er understøtter DELETE, GET, HEAD, PUT, POST og PATCH metoderne.
  • Andre valgfrie headerfelter, som krævet af den specificerede URI- og HTTP-metode.

• Valgfrie HTTP-anmodnings-meddelelsesfelter til understøttelse af URI- og HTTP-operationen. For eksempel indeholder POST-operationer MIME-kodede objekter, der sendes som komplekse parametre. For POST- eller PUT-operationer bør MIME-kodningstypen for kroppen også specificeres i Content-type anmodningsheaderen. Nogle tjenester kræver, at du bruger en specifik MIME-type, såsom application/json.

• HTTP-svarbeskedheaderfelter:

  • En HTTP-statuskode, der spænder fra 2xx succeskoder til 4xx eller 5xx fejlkoder. Alternativt kan en servicedefineret statuskode returneres, som angivet i API-dokumentationen.
  • Andre valgfrie headerfelter, som kræves for at understøtte anmodningens svar, såsom et Content-type svarheader.

• Valgfrie HTTP-svarbeskedens hovedfelter :

  • MIME-kodede responsobjekter returneres i HTTP-responskroppen, såsom et svar fra en GET-metode, der returnerer data. Typisk returneres disse objekter i et struktureret format såsom JSON eller XML, som angivet af Content-type svarheaderen.

API-dokumentation

Et moderne REST API kalder på moderne API-dokumentation. REST API'en er bygget på OpenAPI-specifikationen (også kendt som swagger-specifikationen), og dokumentation er tilgængelig på Microsoft Learn.

Test-API-kald

Et værktøj til test af HTTP-anmodninger/svar-beskeder er Fiddler. Fiddler er en gratis webfejlsøgningsproxy, der kan opsnappe dine REST-anmodninger, hvilket gør det nemt at diagnosticere HTTP-anmodninger/svarbeskeder.

Relateret indhold

Gennemgå de tilgængelige API'er på Microsoft Learn.

Eksempler er tilgængelige på GitHub. Eksemplet inkluderer en HTML5-app bygget på TypeScript, React og webpack sammen med et PowerShell-eksempel.

Har du flere spørgsmål? Prøv at spørge Power BI-community'et