Sdílet prostřednictvím

Vývoj s využitím rozhraní REST API pro Server sestav Power BI

  • Článek

Server sestav Power BI podporují rozhraní REST (Representational State Transfer) API. Rozhraní REST API jsou koncové body služby, které podporují sadu operací HTTP (metod), které poskytují přístup k vytváření, načítání, aktualizaci nebo odstraňování prostředků na serveru sestav.

Rozhraní REST API poskytuje programový přístup k objektům v katalogu Server sestav Power BI. Mezi příklady objektů patří složky, sestavy, klíčové ukazatele výkonu, zdroje dat, datové sady, plány aktualizace, předplatná a další. Pomocí rozhraní REST API můžete například procházet hierarchii složek, zjišťovat obsah složky nebo stahovat definici sestavy. Můžete také vytvářet, aktualizovat a odstraňovat objekty. Příkladem práce s objekty je nahrání sestavy, spuštění plánu aktualizace, odstranění složky atd.

Poznámka:

Pokud vás zajímá zobrazení nebo odstranění osobních údajů, přečtěte si pokyny Microsoftu v žádostech subjektů údajů o gdpr ve Windows. Pokud hledáte obecné informace o GDPR, přečtěte si část GDPR na portálu Service Trust Portal.

Komponenty požadavku nebo odpovědi rozhraní REST API

Pár požadavků a odpovědí rozhraní REST API je možné rozdělit do pěti komponent:

  • Identifikátor URI požadavku, který se skládá z: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}. I když je identifikátor URI požadavku zahrnutý v hlavičce zprávy požadavku, voláme ho zde samostatně, protože většina jazyků nebo architektur vyžaduje, abyste ho předali odděleně od zprávy požadavku.

    • Schéma identifikátoru URI: Označuje protokol použitý k přenosu požadavku. Například http nebo https.
    • Hostitel URI: Určuje název domény nebo IP adresu serveru, kde je hostovaný koncový bod služby REST, například myserver.contoso.com.
    • Cesta k prostředku: Určuje prostředek nebo kolekci prostředků, které může zahrnovat více segmentů používaných službou při určování výběru těchto prostředků. Příklad: CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties Lze použít k získání zadaných vlastností pro CatalogItem.
    • Řetězec dotazu (volitelné): Poskytuje další jednoduché parametry, jako jsou verze rozhraní API nebo kritéria výběru prostředků.

  • Pole hlavičky zprávy požadavku HTTP:

    • Požadovaná metoda HTTP (označovaná také jako operace nebo příkaz), která službě říká, jaký typ operace požadujete. Rozhraní REST API služby Reporting Services podporují metody DELETE, GET, HEAD, PUT, POST a PATCH.
    • Nepovinná další pole hlaviček podle požadavků zadaného identifikátoru URI a metody HTTP.

  • Volitelná pole textu zprávy požadavku HTTP pro podporu identifikátoru URI a operace HTTP. Například operace POST obsahují objekty kódované POMOCÍ MIME, které se předávají jako komplexní parametry. V případě operací POST nebo PUT by měl být v hlavičce požadavku zadán Content-type také typ kódování MIME pro tělo. Některé služby vyžadují, abyste použili konkrétní typ MIME, například application/json.

  • Pole hlavičky zprávy HTTP:

    • Stavový kód HTTP, od kódů úspěchu 2xx až po kódy chyb 4xx nebo 5xx. Případně může být vrácen stavový kód definovaný službou, jak je uvedeno v dokumentaci k rozhraní API.
    • Nepovinná další pole hlaviček, která jsou potřebná pro podporu odpovědi požadavku, například hlavičky Content-type odpovědi.

  • Volitelná pole textu zprávy HTTP:

    • Objekty odpovědi kódované pomocí MIME se vrátí v těle odpovědi HTTP, například odpověď z metody GET, která vrací data. Tyto objekty se obvykle vrací ve strukturovaném formátu, jako je JSON nebo XML, jak je uvedeno Content-type v hlavičce odpovědi.

Dokumentace k rozhraní API

Moderní rozhraní REST API volá moderní dokumentaci k rozhraní API. Rozhraní REST API je založené na specifikaci OpenAPI (a.k.a. specifikace swaggeru) a dokumentaci je k dispozici v Microsoft Learn.

Testování volání rozhraní API

Fiddler je nástroj pro testování zpráv požadavků a odpovědí HTTP. Fiddler je bezplatný proxy pro webové ladění, které může zachycovat vaše požadavky REST, což usnadňuje diagnostiku zpráv požadavků HTTP a odpovědí.

Související obsah

Projděte si dostupná rozhraní API v Microsoft Learn.

Ukázky jsou k dispozici na GitHubu. Ukázka obsahuje aplikaci HTML5 postavenou na TypeScriptu, Reactu a webpacku spolu s příkladem PowerShellu.

Máte ještě další otázky? Zkuste se zeptat Komunita Power BI