Läs på engelska

Dela via


Utveckla med REST-API:er för Power BI-rapportserver

Power BI-rapportserver stöder REST-API:er (Representational State Transfer). REST-API:erna är tjänstslutpunkter som stöder en uppsättning HTTP-åtgärder (metoder), som tillhandahåller åtkomst för att skapa, hämta, uppdatera eller ta bort åtkomst för resurser på en rapportserver.

REST-API:et ger programmatisk åtkomst till objekten i en Power BI-rapportserver katalog. Exempel på objekt är mappar, rapporter, KPI:er, datakällor, datauppsättningar, uppdateringsplaner, prenumerationer med mera. Med rest-API:et kan du till exempel navigera i mapphierarkin, identifiera innehållet i en mapp eller ladda ned en rapportdefinition. Du kan också skapa, uppdatera och ta bort objekt. Exempel på hur du arbetar med objekt är att ladda upp en rapport, köra en uppdateringsplan, ta bort en mapp och så vidare.

Anteckning

Om du är intresserad av att visa eller ta bort personliga data kan du läsa Microsofts vägledning i Windows datasubjektbegäranden för GDPR-webbplatsen . Om du letar efter allmän information om GDPR kan du läsa avsnittet GDPR i Service Trust-portalen.

Komponenter i en REST API-begäran/-svar

Ett REST API-begäran/svarspar kan delas upp i fem komponenter:

  • Begärande-URI:n, som består av: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}. Även om begärande-URI:n ingår i meddelandehuvudet för begäran, anropar vi den separat här eftersom de flesta språk eller ramverk kräver att du skickar den separat från begärandemeddelandet.

    • URI-schema: Anger det protokoll som används för att överföra begäran. Exempel: http eller https.
    • URI-värd: Anger domännamnet eller IP-adressen för servern där REST-tjänstslutpunkten finns, till exempel myserver.contoso.com.
    • Resurssökväg: Anger resurs- eller resurssamlingen, som kan innehålla flera segment som används av tjänsten för att fastställa valet av dessa resurser. Till exempel: CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties kan användas för att hämta de angivna egenskaperna för CatalogItem.
    • Frågesträng (valfritt): Innehåller ytterligare enkla parametrar, till exempel API-versionen eller kriterier för resursval.
  • Meddelandehuvudfält för HTTP-begäran:

    • En nödvändig HTTP-metod (kallas även en åtgärd eller ett verb), som talar om för tjänsten vilken typ av åtgärd du begär. Rest-API:er för Reporting Services stöder metoderna DELETE, GET, HEAD, PUT, POST och PATCH.
    • Valfria ytterligare rubrikfält, enligt vad som krävs av den angivna URI- och HTTP-metoden.
  • Valfria meddelandetextfält för HTTP-begäran för att stödja URI- och HTTP-åtgärden. POST-åtgärder innehåller till exempel MIME-kodade objekt som skickas som komplexa parametrar. För POST- eller PUT-åtgärder bör ÄVEN MIME-kodningstypen för brödtexten Content-type anges i begärandehuvudet. Vissa tjänster kräver att du använder en viss MIME-typ, till exempel application/json.

  • FÄLT för HTTP-svarsmeddelanderubrik:

    • En HTTP-statuskod, från 2xx lyckade koder till 4xx- eller 5xx-felkoder. Alternativt kan en tjänstdefinierad statuskod returneras, enligt beskrivningen i API-dokumentationen.
    • Valfria ytterligare rubrikfält som krävs för att stödja begärans svar, till exempel ett Content-type svarshuvud.
  • Valfria brödtextfält för HTTP-svarsmeddelande:

    • MIME-kodade svarsobjekt returneras i HTTP-svarstexten, till exempel ett svar från en GET-metod som returnerar data. Vanligtvis returneras dessa objekt i ett strukturerat format, till exempel JSON eller XML, vilket anges av svarshuvudet Content-type .

API-dokumentation

Ett modernt REST API kräver modern API-dokumentation. REST-API:et bygger på OpenAPI-specifikationen (t.ex. swagger-specifikationen) och dokumentationen är tillgänglig på Microsoft Learn.

Testa API-anrop

Ett verktyg för att testa HTTP-begäran/svarsmeddelanden är Fiddler. Fiddler är en kostnadsfri webbfelsökningsproxy som kan fånga upp dina REST-begäranden, vilket gör det enkelt att diagnostisera HTTP-begäran/svarsmeddelanden.

Granska de tillgängliga API:erna på Microsoft Learn.

Exempel finns på GitHub. Exemplet innehåller en HTML5-app som bygger på TypeScript, React och webpack tillsammans med ett PowerShell-exempel.

Har du fler frågor? Prova att fråga Power BI Community