Čítať v angličtine

Zdieľať cez

Vývoj s rozhraniami REST API pre Power BI Report Server

  • Článok

Power BI Report Server podporuje rozhranie Representational State Transfer (REST) API. Rozhrania REST API sú koncové body služby podporujúceho množinu operácií (metód) HTTP, ktoré poskytujú prístup k vytváraniu, načítaniu, aktualizovaniu alebo odstraňovaniu zdrojov na serveri zostáv.

Rozhranie REST API poskytuje programový prístup k objektom v katalógu Power BI Report Servera. Príkladmi objektov sú priečinky, zostavy, kľúčové ukazovatele výkonu, zdroje údajov, množiny údajov, plány obnovy, prihlásenia na odber a ďalšie objekty. Pomocou rozhrania REST API môžete napríklad prechádzať v hierarchii priečinkov, zisťovať obsah priečinka alebo sťahovať definície zostáv. Môžete tiež vytvárať, aktualizovať a odstraňovať objekty. Medzi prácu s objektmi patrí napríklad nahrávanie zostáv, vykonávanie plánu obnovy, odstraňovanie priečinkov a podobne.

Poznámka

Ak máte záujem o zobrazenie alebo vymazanie osobných údajov, skontrolujte sprievodný materiál spoločnosti Microsoft v téme Žiadosti dotknutých osôb vo Windowse v rámci nariadenia GDPR . Ak máte záujem o všeobecné informácie týkajúce sa všeobecného nariadenia o ochrane údajov (GDPR), pozrite si tému Časť portálu Service Trust Portal o ochrane údajov podľa nariadenia GDPR.

Súčasti požiadavky/odpovede rozhrania REST API

Dvojicu požiadavka/odpoveď rozhrania REST API je možné rozdeliť na päť súčastí:

  • Identifikátor URI požiadavky, ktorý sa skladá z týchto: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}. Napriek tomu, že identifikátor URI požiadavky je súčasťou hlavičky správy s požiadavkou, voláme ho samostatne, pretože väčšina jazykov alebo rámcov vyžaduje jeho odoslanie samostatne od správy s požiadavkou.

    • Schéma URI: označuje protokol používaný na prenos požiadavky. Napríklad http alebo https.
    • Hostiteľ URI: určuje názov domény alebo IP adresu servera, na ktorom je hosťovaný koncový bod služby REST, napríklad myserver.contoso.com.
    • Cesta k zdroju: určuje zdroj alebo kolekciu zdrojov, ktoré môžu zahŕňať viacero segmentov používaných službou pri určovaní výberu týchto zdrojov. Napríklad: CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties možno použiť na získanie zadaných vlastností pre položku Katalóg.
    • Reťazec dotazu (voliteľné): poskytuje ďalšie jednoduché parametre, napríklad verziu rozhrania API alebo kritériá výberu zdrojov.

  • Polia hlavičky správy s požiadavkou HTTP:

    • Povinná metóda HTTP (známa aj ako operácia alebo sloveso), ktorá službe oznámi, aký typ operácie požadujete. Rozhrania REST API služieb Reporting Services podporujú metódy DELETE, GET, HEAD, PUT, POST, a PATCH.
    • Voliteľné ďalšie polia hlavičky vyžadované zadaným identifikátorom URI a metódou HTTP.

  • Voliteľné polia tela správy s požiadavkou HTTP na podporu identifikátora URI a operácie HTTP. Napríklad operácie POST obsahujú objekty s kódovaním MIME, ktoré sú odovzdané ako komplexné parametre. V prípade operácií POST alebo PUT je potrebné zadať Content-type do hlavičky požiadavky aj typ kódovania MIME pre telo správy. Niektoré služby vyžadujú použitie konkrétneho typu rozhrania MIME, napríklad application/json.

  • Polia hlavičky správy s odpoveďou HTTP:

    • Kód stavu HTTP, od 2xx kódov úspechu po 4xx alebo 5xx kódov chýb. Prípadne sa môže vrátiť kód stavu definovaný službou tak, ako sa uvádza v dokumentácii o rozhraní API.
    • Voliteľné ďalšie polia hlavičky vyžadované na podporu odpovede na požiadavku, napríklad hlavička Content-type odpovede.

  • Voliteľné polia tela správy s odpoveďou HTTP:

    • Objekty odpovede s kódovaním MIME sa vrátia v tele odpovede HTTP, napríklad odpovede z metódy GET, ktorá vracia údaje. Tieto objekty sa zvyčajne vracajú v štruktúrovanom formáte, ako je napríklad JSON alebo XML, ktorý je uvedený v hlavičke Content-type odpovede.

Dokumentácia k API

Moderné rozhranie REST API vyžaduje modernú dokumentáciu o rozhraní API. Rozhranie REST API vychádza zo špecifikácie OpenAPI (tiež používanej ako špecifikácia swagger) a dokumentácia je k dispozícii na lokalite Microsoft Learn.

Testovanie volaní API

Nástroj na testovanie správ s požiadavkou/odpoveďou HTTP je Fiddler. Nástroj Fiddler je bezplatná proxy služba na ladenie webu, ktorá môže zachytiť vaše požiadavky REST a uľahčuje diagnostikovanie správy s požiadavkou/odpoveďou HTTP.

Súvisiaci obsah

Pozrite si dostupné rozhrania API v službe Microsoft Learn.

Ukážky sú k dispozícii v GitHube. Ukážka obsahuje aplikáciu HTML5 založenú na jazyku TypeScript, React a webpack spolu s príkladom prostredia PowerShell.

Máte ďalšie otázky? Skúste sa spýtať Komunita Power BI