Développer avec les API REST pour Power BI Report Server

Power BI Report Server prend en charge les API REST (Representational State Transfer). Les API REST sont des points de terminaison de service qui prennent en charge un ensemble d’opérations HTTP (méthodes), qui fournissent l’accès de création, de récupération, de mise à jour ou de suppression des ressources au sein d’un serveur de rapports.

L’API REST fournit un accès programmatique aux objets d’un catalogue Power BI Report Server. Des exemples d’objets sont des dossiers, des rapports, des indicateurs de performance clés, des sources de données, des jeux de données, des plans d’actualisation, des abonnements, etc. À l’aide de l’API REST, vous pouvez, par exemple, naviguer dans la hiérarchie des dossiers, découvrir le contenu d’un dossier ou télécharger une définition de rapport. Vous pouvez également créer, mettre à jour et supprimer des objets. Des exemples d’utilisation d’objets chargent un rapport, exécutent un plan d’actualisation, suppriment un dossier, et ainsi de suite.

Note

Si vous voulez voir ou supprimer des données personnelles, consultez les conseils de Microsoft sur le site Demandes des personnes concernées pour Windows concernant le RGPD. Si vous recherchez des informations générales sur le RGPD, consultez la section RGPD du portail d’approbation de services.

Composants d’une requête/réponse d’API REST

Une paire de demandes/réponses d’API REST peut être séparée en cinq composants :

• URI de requête, qui se compose de : {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}. Bien que l’URI de la demande soit inclus dans l’en-tête du message de requête, nous l’appelons séparément ici, car la plupart des langages ou infrastructures vous obligent à le transmettre séparément du message de demande.

  • Schéma d’URI : indique le protocole utilisé pour transmettre la requête. Par exemple, http ou https.
  • Hôte d’URI : spécifie le nom de domaine ou l’adresse IP du serveur sur lequel le point de terminaison de service REST est hébergé, comme myserver.contoso.com par exemple.
  • Chemin d’accès aux ressources : spécifie la ressource ou la collection de ressources, qui peut inclure plusieurs segments utilisés par le service pour déterminer la sélection de ces ressources. Par exemple : CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties peut être utilisé pour obtenir les propriétés spécifiées pour CatalogItem.
  • Chaîne de requête (facultatif) : fournit d’autres paramètres simples, tels que la version de l’API ou les critères de sélection des ressources.

• Champs d’en-tête de message de requête HTTP :

  • Méthode HTTP requise (également appelée opération ou verbe), qui indique au service quel type d’opération vous demandez. Les API REST Reporting Services prennent en charge les méthodes DELETE, GET, HEAD, PUT, POST et PATCH.
  • Autres champs d’en-tête facultatifs, comme requis par l’URI et la méthode HTTP spécifiés.

• Champs de corps de message de requête HTTP facultatifs afin de supporter l’URI et l’opération HTTP. Par exemple, les opérations POST contiennent des objets encodés MIME qui sont passés en tant que paramètres complexes. Pour les opérations POST ou PUT, le type d’encodage MIME pour le corps doit également être spécifié dans l’en-tête Content-type de la requête. Certains services nécessitent que vous utilisiez un type MIME spécifique, tel que application/json.

• Champs d’en-tête de message de réponse HTTP :

  • Code d’état HTTP, allant des codes de réussite 2xx aux codes d’erreur 4xx ou 5xx. Vous pouvez également renvoyer un code d’état défini par le service, comme indiqué dans la documentation de l’API.
  • Autres champs d’en-tête facultatifs, si nécessaire pour prendre en charge la réponse de la demande, tel qu'un en-tête de réponse Content-type.

• Champs de corps de message de réponse HTTP facultatifs :

  • Les objets de réponse encodés MIME sont retournés dans le corps de la réponse HTTP, par exemple une réponse d’une méthode GET qui retourne des données. En règle générale, ces objets sont retournés dans un format structuré tel que JSON ou XML, comme indiqué par l’en-tête de Content-type réponse.

Documentation sur l’API

Une API REST moderne nécessite une documentation de l’API tout aussi moderne. L’API REST repose sur la spécification OpenAPI (également appelée spécification swagger) et la documentation est disponible sur Microsoft Learn.

Test des appels d’API

Un outil pour tester les messages de requête/réponse HTTP est Fiddler. Fiddler est un proxy de débogage web gratuit qui peut intercepter vos requêtes REST, ce qui facilite le diagnostic des messages de requête/réponse HTTP.

Contenu connexe

Passez en revue les API disponibles sur Microsoft Learn.

Les exemples sont disponibles sur GitHub. L’exemple inclut une application HTML5 basée sur TypeScript, React et webpack, ainsi qu’un exemple PowerShell.

Plus de questions ? Essayez d’interroger la communauté Power BI