Reports - Get Reports

  • Référence
Service:
Power BI REST APIs
API Version:
v1.0

Retourne une liste de rapports de Mon espace de travail.

Cette API retourne également des rapports et des rapports partagés à partir d’applications partagées. Les rapports qui résident dans des espaces de travail partagés sont accessibles à l’aide de l’API Obtenir des rapports dans le groupe.

Étant donné que les rapports paginés (RDL) n’ont pas de jeu de données, la valeur d’ID de jeu de données dans la réponse de l’API pour les rapports paginés n’est pas affichée.

Étendue requise

Report.ReadWrite.All ou Report.Read.All

GET https://api.powerbi.com/v1.0/myorg/reports

Réponses

Nom Type Description
200 OK

Reports

Ok

Exemples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/reports

Sample Response

Status code:
200 
{
  "value": [
    {
      "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com//reports/5b218778-e7a5-4d73-8187-f10824047715",
      "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715"
    }
  ]
}

Définitions

Nom Description
PrincipalType

Type principal
Report

Un rapport Power BI. L’API retourne un sous-ensemble de la liste suivante de propriétés de rapport. Le sous-ensemble dépend de l’API appelée, des autorisations de l’appelant et de la disponibilité des données dans la base de données Power BI.
Reports

Wrapper de réponse OData pour une collection de rapports Power BI
ReportUser

Entrée de droit d’accès utilisateur Power BI pour un rapport
ReportUserAccessRight

Droit d’accès dont dispose l’utilisateur pour le rapport (niveau d’autorisation)
ServicePrincipalProfile

Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire.
Subscription

Un abonnement de messagerie pour un élément Power BI (tel qu’un rapport ou un tableau de bord)
SubscriptionUser

Un utilisateur d’abonnement de messagerie Power BI

PrincipalType

Type principal

Nom Type Description
App

string

Type de principal de service
Group

string

Type de principal de groupe
None

string

Aucun type principal. Utilisez pour un accès de niveau organization entier.
User

string

Type de principal d’utilisateur

Report

Un rapport Power BI. L’API retourne un sous-ensemble de la liste suivante de propriétés de rapport. Le sous-ensemble dépend de l’API appelée, des autorisations de l’appelant et de la disponibilité des données dans la base de données Power BI.

Nom Type Description
appId

string

ID d’application, retourné uniquement si le rapport appartient à une application
datasetId

string

ID de jeu de données du rapport
description

string

Description du rapport
embedUrl

string

URL d’incorporation du rapport
id

string

ID de rapport
name

string

Nom du rapport
originalReportId

string

ID de rapport réel lorsque l’espace de travail est publié en tant qu’application.
reportType enum:
  • PaginatedReport
  • PowerBIReport

Type de rapport
subscriptions

Subscription[]

(Valeur vide) Détails de l’abonnement pour un élément Power BI (tel qu’un rapport ou un tableau de bord). Cette propriété sera supprimée de la réponse de charge utile dans une version à venir. Vous pouvez récupérer des informations d’abonnement pour un rapport Power BI à l’aide de l’option Obtenir des abonnements de rapport en tant qu’appel d’API Administration.
users

ReportUser[]

(Valeur vide) Détails d’accès utilisateur pour un rapport Power BI. Cette propriété sera supprimée de la réponse de charge utile dans une version à venir. Vous pouvez récupérer les informations utilisateur d’un rapport Power BI à l’aide de l’appel d’API Get Report Users as Administration, ou de l’appel d’API PostWorkspaceInfo avec le getArtifactUsers paramètre .
webUrl

string

URL web du rapport

Reports

Wrapper de réponse OData pour une collection de rapports Power BI

Nom Type Description
odata.context

string

Contexte OData
value

Report[]

Collection de rapports

ReportUser

Entrée de droit d’accès utilisateur Power BI pour un rapport

Nom Type Description
displayName

string

Nom d’affichage du principal
emailAddress

string

Adresse e-mail de l’utilisateur
graphId

string

Identificateur du principal dans Microsoft Graph. Disponible uniquement pour les API d’administration.
identifier

string

Identificateur du principal
principalType

PrincipalType

Type principal
profile

ServicePrincipalProfile

Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire.
reportUserAccessRight

ReportUserAccessRight

Droit d’accès dont dispose l’utilisateur pour le rapport (niveau d’autorisation)
userType

string

Type de l’utilisateur.

ReportUserAccessRight

Droit d’accès dont dispose l’utilisateur pour le rapport (niveau d’autorisation)

Nom Type Description
None

string

Aucune autorisation d’accès au contenu dans le rapport
Owner

string

Octroie l’accès en lecture, écriture et repartage au contenu du rapport
Read

string

Octroie l’accès en lecture au contenu du rapport
ReadCopy

string

Octroie l’accès en lecture et en copie au contenu du rapport
ReadReshare

string

Octroie l’accès en lecture et repartage au contenu du rapport
ReadWrite

string

Octroie l’accès en lecture et en écriture au contenu du rapport

ServicePrincipalProfile

Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire.

Nom Type Description
displayName

string

Nom du profil principal de service
id

string

ID de profil du principal de service

Subscription

Un abonnement de messagerie pour un élément Power BI (tel qu’un rapport ou un tableau de bord)

Nom Type Description
artifactDisplayName

string

Nom de l’élément Power BI abonné (par exemple, un rapport ou un tableau de bord)
artifactId

string

ID de l’élément Power BI abonné (tel qu’un rapport ou un tableau de bord)
artifactType

string

Type d’élément Power BI (par exemple Report, Dashboardou Dataset)
attachmentFormat

string

Format du rapport joint dans l’abonnement par e-mail
endDate

string

Date et heure de fin de l’abonnement par e-mail
frequency

string

Fréquence de l’abonnement par e-mail
id

string

ID d’abonnement
isEnabled

boolean

Si l’abonnement de messagerie est activé
linkToContent

boolean

Si un lien d’abonnement existe dans l’abonnement par e-mail
previewImage

boolean

Si une capture d’écran du rapport existe dans l’abonnement par e-mail
startDate

string

Date et heure de début de l’abonnement par e-mail
subArtifactDisplayName

string

Nom de page de l’élément Power BI abonné, s’il s’agit d’un rapport.
title

string

Nom de l’application
users

SubscriptionUser[]

Détails de chaque abonné à l’e-mail. Lors de l’utilisation de l’appel d’API Get User Subscriptions As Administration, la valeur retournée est un tableau vide (null). Cette propriété sera supprimée de la réponse de charge utile dans une version à venir. Vous pouvez récupérer des informations d’abonnement sur un rapport ou un tableau de bord Power BI à l’aide des appels d’API Get Report Subscriptions As Administration ou Get Dashboard Subscriptions As Administration.

SubscriptionUser

Un utilisateur d’abonnement de messagerie Power BI

Nom Type Description
displayName

string

Nom d’affichage du principal
emailAddress

string

Adresse e-mail de l’utilisateur
graphId

string

Identificateur du principal dans Microsoft Graph. Disponible uniquement pour les API d’administration.
identifier

string

Identificateur du principal
principalType

PrincipalType

Type principal
profile

ServicePrincipalProfile

Profil principal service Power BI. Ne concerne que Power BI Embedded solution multilocataire.
userType

string

Type de l’utilisateur.