Jaa

Kehitä Power BI -raporttipalvelin REST-ohjelmointirajapintojen avulla

  • Artikkeli

Power BI -raporttipalvelin tukea Representational State Transfer (REST) -ohjelmointirajapintoja. REST-ohjelmointirajapinnat ovat palvelun päätepisteitä, jotka tukevat joukkoa HTTP-toimintoja (menetelmiä), jotka tarjoavat pääsyn raporttipalvelimen sisältämien resurssien luomiseen, hakemiseen, päivittämiseen tai poistamiseen.

REST-ohjelmointirajapinta tarjoaa ohjelmallisen käyttöoikeuden Power BI -raporttipalvelin luettelon objekteihin. Objekteja ovat esimerkiksi kansiot, raportit, suorituskykyilmaisimet, tietolähteet, tietojoukot, päivityssuunnitelmat, tilaukset ja paljon muuta. REST-ohjelmointirajapinnan avulla voit esimerkiksi siirtyä kansiohierarkiassa, tutustua kansion sisältöön tai ladata raporttimäärityksen. Voit myös luoda, päivittää ja poistaa objekteja. Esimerkkejä objektien kanssa työskentelemisestä ovat raportin lataaminen, päivityssuunnitelman toteuttaminen ja niin edelleen.

Muistiinpano

Jos haluat tarkastella tai poistaa henkilötietoja, tutustu Microsoftin ohjeisiin Windowsin GDPR :lle rekisteröidyt tietopyynnöt -sivustoon. Jos etsit yleistä tietoa GDPR:stä, katso Service Trust -portaalin GDPR-osio.

REST-ohjelmointirajapinnan pyynnön/vastauksen osat

REST-ohjelmointirajapinnan pyyntö/vastaus-pari voidaan jakaa viiteen osaan:

  • Pyynnön URI, joka koostuu: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}. Vaikka pyynnön URI-tunnus on mukana pyynnön otsikossa, kutsumme sen erikseen tässä, koska useimmat kielet tai kehykset edellyttävät sen välittämistä pyyntöviestistä erillään.

    • URI-protokolla: ilmaisee pyynnön välittämiseen käytetyn protokollan. Esimerkiksi http tai https.
    • URI-isäntä: määrittää toimialuenimen tai palvelimen IP-osoitteen, jossa REST-palvelupäätepiste sijaitsee, kuten myserver.contoso.com.
    • Resurssipolku: Määrittää resurssin tai resurssikokoelman ja saattaa sisältää useita segmenttejä, joita palvelu käyttää kyseisten resurssien valinnassa. Esimerkiksi: CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties soveltuu CatalogItemin määritettyjen ominaisuuksien hakemiseen.
    • Kyselyn merkkijono (valinnainen): tarjoaa yksinkertaisia parametreja, kuten ohjelmointirajapinnan version tai resurssinvalinnan ehdot.

  • HTTP-pyyntöviestiotsikon kentät:

    • Pakollinen HTTP-menetelmä (tunnetaan myös nimellä toiminto tai verbitoiminto), joka kertoo palvelulle minkä tyyppinen pyytämäsi toiminnon on. Reporting Services REST -ohjelmointirajapinnat tukevat menetelmiä DELETE, GET, HEAD, PUT, POST ja PATCH.
    • Valinnaisia muita otsikkokenttiä, joita määritetty URI- ja HTTP-menetelmä vaatii.

  • Valinnaiset HTTP-pyyntöviestin tekstikentät , jotka tukevat URI- ja HTTP-toimintoja. Esimerkiksi POST-toiminnot sisältävät MIME-koodattuja objekteja, jotka välitetään monimutkaisina parametreina. POST- tai PUT-toiminnoissa tulee tekstirungon MIME-koodaustyyppi määritellä myös pyyntöotsikossa Content-type . Jotkin palvelut edellyttävät, että käytät tiettyä MIME-tyyppiä, kuten application/json.

  • HTTP-vastausviestiotsikon kentät:

    • HTTP-tilakoodi, joka voi olla aina 2xx-onnistumiskoodeista 4xx- tai 5xx-virhekoodeihin. Vaihtoehtoisesti saatetaan palauttaa palvelun määrittämä tilakoodi, kuten on esitetty ohjelmointirajapinnan dokumentaatiossa.
    • Valinnaisia muita otsikkokenttiä sen mukaan, mitä tarvitaan tukemaan pyynnön vastausta, kuten Content-type vastausotsikko.

  • Valinnainen HTTP-vastausviestin tekstiosakentät :

    • MIME-koodatut vastausobjektit palautetaan HTTP-vastauksen tekstiosassa, kuten tiedot palauttava GET-menetelmän vastaus. Yleensä nämä objektit palautetaan jäsennellyssä muodossa, kuten JSON tai XML, jota Content-type on merkitty vastauksen otsikkoon.

Ohjelmointirajapintadokumentaatio

Nykyaikainen REST-ohjelmointirajapinta vaatii nykyaikaisen ohjelmointirajapintadokumentaation. REST-ohjelmointirajapinta perustuu OpenAPI-määritykseen (eli swagger-määritykseen), ja dokumentaatio on saatavilla Microsoft Learnissa.

API-kutsujen testaaminen

Fiddler on työkalu, jolla voidaan testata HTTP-pyyntö/vastausviestejä. Fiddler on maksuton virheenkorjausvälityspalvelin verkossa, joka voi siepata REST-pyynnöt, mikä helpottaa HTTP-pyyntö/vastausviestien vianmääritystä.

Liittyvä sisältö

Käy läpi Microsoft Learnissa käytettävissä olevat ohjelmointirajapinnat.

Malleja on saatavilla GitHubissa. Malli sisältää TypeScriptiin, Reactiin ja verkkopakettiin perustuvan HTML5-sovelluksen sekä PowerShell-esimerkin.

Onko sinulla lisää kysymyksiä? Voit esittää kysymyksiä Power BI -yhteisö