Dashboards - Add Dashboard In Group

Référence

Service:: Power BI REST APIs

API Version:: v1.0

Crée un tableau de bord vide dans l’espace de travail spécifié.

Autorisations

Cet appel d’API peut être appelé par un profil de principal de service. Pour plus d’informations, consultez Profils de principal de service dans Power BI Embedded.

Étendue requise

Content.Create

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dashboards

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
groupId	path	True	string uuid	L’ID de l’espace de travail

Corps de la demande

Nom	Obligatoire	Type	Description
name	True	string	Nom du nouveau tableau de bord

Réponses

Nom	Type	Description
200 OK	Dashboard	Ok

Exemples

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards

Request Body

{
  "name": "SalesMarketing"
}

Sample Response

Status code:: 200

{
  "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
  "displayName": "SalesMarketing",
  "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48",
  "isReadOnly": false
}

Définitions

Nom	Description
AddDashboardRequest	Une demande Power BI pour ajouter un tableau de bord
Dashboard	Un tableau de bord Power BI. L’API retourne un sous-ensemble de la liste suivante de propriétés de tableau de bord. 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.
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 principal
ServicePrincipalProfile	Profil principal service Power BI. Concerne uniquement Power BI Embedded solution mutualisée.
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

AddDashboardRequest

Une demande Power BI pour ajouter un tableau de bord

Nom	Type	Description
name	string	Nom du nouveau tableau de bord

Dashboard

Un tableau de bord Power BI. L’API retourne un sous-ensemble de la liste suivante de propriétés de tableau de bord. 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 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	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 (par exemple, 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 les informations d’abonnement d’un rapport Power BI à l’aide de l’appel d’API Get Report Subscriptions as Administration.
users	DashboardUser[]	(Valeur vide) Détails de l’accès 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’appel d’API Obtenir des utilisateurs du tableau de bord en tant qu’appel d’API Administration, ou de l’appel d’API PostWorkspaceInfo avec le `getArtifactUsers` paramètre .
webUrl	string	URL web du tableau de bord

DashboardUser

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 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. Concerne uniquement Power BI Embedded solution mutualisée.
userType	string	Type de l’utilisateur.

DashboardUserAccessRight

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

Nom	Type	Description
None	string	Aucune autorisation d’accès au contenu dans le tableau de bord
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 tableau de bord
ReadCopy	string	Octroie l’accès en lecture et copie au contenu du tableau de bord
ReadReshare	string	Octroie l’accès en lecture et repartage au contenu du tableau de bord
ReadWrite	string	Octroie l’accès en lecture et écriture au contenu du tableau de bord

PrincipalType

Type principal

Nom	Type	Description
App	string	Type de principal de service
Group	string	Type de principal de groupe
None	string	Aucun type de principal. Utilisez pour l’ensemble de l’accès au niveau de l’organisation.
User	string	Type de principal d’utilisateur

ServicePrincipalProfile

Profil principal service Power BI. Concerne uniquement Power BI Embedded solution mutualisée.

Nom	Type	Description
displayName	string	Nom du profil de principal de service
id	string	ID de profil du principal de service

Subscription

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é (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 , `ReportDashboard`ou `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	Indique si l’abonnement par e-mail 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 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. 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 prochaine version. 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 Obtenir des abonnements aux rapports en tant que Administration ou Obtenir des abonnements au tableau de bord en tant que 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. Concerne uniquement Power BI Embedded solution mutualisée.
userType	string	Type de l’utilisateur.

Partager via