Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
Platí pro: SQL Server Reporting Services (2017 a novější verze), Server sestav Power BI
Microsoft SQL Server 2017 Reporting Services podporuje rozhraní REST (Representational State Transfer) API. Rozhraní REST API jsou koncové body služby, které podporují sadu operací HTTP (metod). Tyto metody 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 serveru sestav služby SQL Server 2017 Reporting Services. Tady jsou příklady objektů:
- Složky
- Zprávy
- Klíčové ukazatele výkonu (KPI)
- Zdroje dat
- Datové sady
- Aktualizace plánů
- Předplatná
Při použití rozhraní REST API můžete procházet hierarchii složek, prohlížet obsah složky nebo stahovat definici sestavy. Můžete také vytvářet, aktualizovat a odstraňovat objekty.
Poznámka:
Pokud vás zajímá zobrazení nebo odstranění osobních údajů, přečtěte si pokyny společnosti Microsoft na webu žádosti subjektů údajů systému Windows pro GDPR. 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:
- I když je identifikátor URI požadavku zahrnutý v hlavičce zprávy požadavku, většina jazyků nebo architektur vyžaduje, abyste ho předali odděleně od zprávy požadavku.
- Skládá se z
{URI-scheme} :// {URI-host} / {resource-path} ? {query-string}.
Požadavek na URI Description Schéma identifikátoru URI Označuje protokol použitý k přenosu požadavku. Například httpnebohttps.Hostitel identifikátoru 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é mohou zahrnovat více segmentů používaných službou při určování výběru těchto prostředků. Můžete například použít CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Propertiesk získání zadaných vlastností objektuCatalogItem.Řetězec dotazu (volitelné) Poskytuje jednodušší 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.
- Řekne službě, jaký typ operace požadujete. Rozhraní REST API služby Reporting Services podporují metody DELETE, GET, HEAD, PUT, POST a PATCH.
- Volitelná další pole hlaviček podle požadavků zadaného identifikátoru URI a metody HTTP.
Volitelná pole textu zprávy požadavku HTTP:
- Podporuje identifikátor URI a operaci HTTP. Například operace POST obsahují objekty s kódováním MIME (Multipurpose Internet Mail Extensions), 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-typetaké typ kódování MIME pro tělo. Některé služby vyžadují, abyste použili konkrétní typ MIME, napříkladapplication/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.
- Volitelná další pole hlaviček, která jsou nutná pro podporu odpovědi požadavku, například hlavičky
Content-typeodpově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-typev hlavičce odpovědi.
- 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
Dokumentace k rozhraní API
Moderní REST API vyžaduje moderní dokumentaci k API. Rozhraní REST API je založené na specifikaci OpenAPI, která se označuje také jako specifikace Swagger. Dokumentace k Power BI Report Server REST API je k dispozici v Microsoft Learn.
Testování volání rozhraní API
Pokud potřebujete 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ů a odpovědí HTTP.