Partager via

Dashboards - Get Dashboard

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

Retourne le tableau de bord spécifié à partir de Mon espace de travail.

Étendue requise

Dashboard.ReadWrite.All ou Dashboard.Read.All 

GET https://api.powerbi.com/v1.0/myorg/dashboards/{dashboardId}

Paramètres URI

Nom Dans Obligatoire Type Description
dashboardId
 path True

string (uuid)

ID du tableau de bord

Réponses

Nom Type Description
200 OK

Dashboard

D’ACCORD

Exemples

Example

Exemple de requête

GET https://api.powerbi.com/v1.0/myorg/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af

Exemple de réponse

Code d’état:
200 
{
  "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
  "displayName": "SalesMarketing",
  "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
  "isReadOnly": false
}

Définitions

Nom Description
Dashboard

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

Entrée de droit d’accès utilisateur Power BI pour un tableau de bord
DashboardUserAccessRight

Droit d’accès dont dispose l’utilisateur pour le tableau de bord (niveau d’autorisation)
PrincipalType

Type de principal
ServicePrincipalProfile

Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
Subscription

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

Un utilisateur d’abonnement de messagerie Power BI

Dashboard

Object

Tableau de bord Power BI. L’API retourne un sous-ensemble de la liste suivante des propriétés du tableau de bord. Le sous-ensemble dépend de l’API appelée, des autorisations d’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 tableau de bord appartient à une application
displayName

string

Nom complet du tableau de bord
embedUrl

string

URL incorporée du tableau de bord
id

string (uuid)

ID du tableau de bord
isReadOnly

boolean

Indique si le tableau de bord est en lecture seule
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 prochaine version. Vous pouvez récupérer des informations d’abonnement pour un rapport Power BI à l’aide de l'Obtenir des abonnements de rapport en tant qu’appel d’API d’administrateur.
users

DashboardUser[]

(Valeur vide) Détails de l’accès de l’utilisateur au tableau de bord. Cette propriété sera supprimée de la réponse de charge utile dans une prochaine version. Vous pouvez récupérer des informations utilisateur sur un tableau de bord Power BI à l’aide de l'Obtenir des utilisateurs de tableau de bord en tant qu’appel d’API administrateur, ou l’appel d’API PostWorkspaceInfo avec le paramètre getArtifactUsers.
webUrl

string

URL web du tableau de bord

DashboardUser

Object

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

Nom Type Description
dashboardUserAccessRight

DashboardUserAccessRight

Droit d’accès dont dispose l’utilisateur pour le tableau de bord (niveau d’autorisation)
displayName

string

Nom complet 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 de principal
profile

ServicePrincipalProfile

Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
userType

string

Type de l’utilisateur.

DashboardUserAccessRight

Énumération

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

Valeur Description
None

Aucune autorisation pour le contenu dans le tableau de bord
Owner

Accorde l’accès en lecture, écriture et partage à nouveau au contenu dans le rapport
Read

Octroie l’accès en lecture au contenu dans le tableau de bord
ReadCopy

Octroie l’accès en lecture et copie au contenu dans le tableau de bord
ReadReshare

Accorde l’accès en lecture et repartage au contenu dans le tableau de bord
ReadWrite

Octroie l’accès en lecture et écriture au contenu dans le tableau de bord

PrincipalType

Énumération

Type de principal

Valeur Description
App

Type de principal de service
Group

Type de principal de groupe
None

Aucun type de principal. Utiliser pour l’ensemble de l’accès au niveau de l’organisation.
User

Type de principal de l’utilisateur

ServicePrincipalProfile

Object

Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.

Nom Type Description
displayName

string

Nom du profil du principal de service
id

string (uuid)

ID de profil du principal de service

Subscription

Object

Un abonnement par e-mail 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é (tel qu’un rapport ou un tableau de bord)
artifactId

string (uuid)

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, un Report, Dashboardou Dataset)
attachmentFormat

string

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

string (date-time)

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

string

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

string (uuid)

ID d’abonnement
isEnabled

boolean

Indique si l’abonnement par e-mail est activé
linkToContent

boolean

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

boolean

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

string (date-time)

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

string

Nom de la 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. Lorsque vous utilisez l'Obtenir des abonnements utilisateur en tant qu’appel d’API administrateur, la valeur retournée est un tableau vide (null). Cette propriété sera supprimée de la réponse de charge utile dans une prochaine version. Vous pouvez récupérer des informations d’abonnement sur un rapport Ou un tableau de bord Power BI à l’aide de l'Obtenir des abonnements de rapport en tant qu’administrateur ou Obtenir des abonnements de tableau de bord en tant qu’appels d’API d’administrateur.

SubscriptionUser

Object

Un utilisateur d’abonnement de messagerie Power BI

Nom Type Description
displayName

string

Nom complet 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 de principal
profile

ServicePrincipalProfile

Profil de principal du service Power BI. Uniquement pertinent pour solution multilocataire Power BI Embedded.
userType

string

Type de l’utilisateur.