Apps - Get Dashboard

Dienst:

Power BI REST APIs

API-Version:

v1.0

Gibt das angegebene Dashboard aus der angegebenen App zurück.

Erforderlicher Bereich

Dashboard.ReadWrite.All oder Dashboard.Read.All

Einschränkungen

Die Dienstprinzipalauthentifizierung wird nicht unterstützt.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
appId	path	True	string (uuid)	Die App-ID
dashboardId	path	True	string (uuid)	Die Dashboard-ID

Antworten

Name	Typ	Beschreibung
200 OK	Dashboard	OKAY

Beispiele

Example

Beispielanforderung

GET https://api.powerbi.com/v1.0/myorg/apps/3d9b93c6-7b6d-4801-a491-1738910904fd/dashboards/{dashboardId}

Beispiel für eine Antwort

Statuscode:

200

{
  "appId": "3d9b93c6-7b6d-4801-a491-1738910904fd",
  "id": "03dac094-2ff8-47e8-b2b9-dedbbc4d22ac",
  "displayName": "SalesMarketing",
  "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=335aee4b-7b38-48fd-9e2f-306c3fd67482&appId=3d9b93c6-7b6d-4801-a491-1738910904fd&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6Ly9XQUJJLVNPVVRILUNFTlRSQUwtVVMtcmVkaXJlY3QuYW5hbHlzaXMud2luZG93cy5uZXQifQ%3d%3d",
  "isReadOnly": false
}

Definitionen

Name	Beschreibung
Dashboard	Ein Power BI-Dashboard. Die API gibt eine Teilmenge der folgenden Liste der Dashboardeigenschaften zurück. Die Teilmenge hängt von der aufgerufenen API, den Aufruferberechtigungen und der Verfügbarkeit von Daten in der Power BI-Datenbank ab.
DashboardUser	Ein Power BI-Benutzerzugriff für ein Dashboard
DashboardUserAccessRight	Das Zugriffsrecht, das der Benutzer für das Dashboard hat (Berechtigungsstufe)
PrincipalType	Der Prinzipaltyp
ServicePrincipalProfile	Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
Subscription	Ein E-Mail-Abonnement für ein Power BI-Element (z. B. einen Bericht oder ein Dashboard)
SubscriptionUser	Ein Power BI-E-Mail-Abonnementbenutzer

Dashboard

Objekt

Ein Power BI-Dashboard. Die API gibt eine Teilmenge der folgenden Liste der Dashboardeigenschaften zurück. Die Teilmenge hängt von der aufgerufenen API, den Aufruferberechtigungen und der Verfügbarkeit von Daten in der Power BI-Datenbank ab.

Name	Typ	Beschreibung
appId	string	Die App-ID, die nur zurückgegeben wird, wenn das Dashboard zu einer App gehört
displayName	string	Der Anzeigename des Dashboards
embedUrl	string	Die Einbettungs-URL des Dashboards
id	string (uuid)	Die Dashboard-ID
isReadOnly	boolean	Gibt an, ob das Dashboard schreibgeschützt ist.
subscriptions	Subscription[]	(Leerer Wert) Die Abonnementdetails für ein Power BI-Element (z. B. einen Bericht oder ein Dashboard). Diese Eigenschaft wird aus der Nutzlastantwort in einer bevorstehenden Version entfernt. Sie können Abonnementinformationen für einen Power BI-Bericht abrufen, indem Sie den Abrufen von Berichtsabonnements als Administrator- API-Aufruf verwenden.
users	DashboardUser[]	(Leerer Wert) Details des Dashboardbenutzerzugriffs. Diese Eigenschaft wird aus der Nutzlastantwort in einer bevorstehenden Version entfernt. Sie können Benutzerinformationen auf einem Power BI-Dashboard abrufen, indem Sie den Abrufen von Dashboardbenutzern als Administrator- API-Aufruf oder den PostWorkspaceInfo-API-Aufruf mit dem parameter getArtifactUsers verwenden.
webUrl	string	Die Web-URL des Dashboards

DashboardUser

Objekt

Ein Power BI-Benutzerzugriff für ein Dashboard

Name	Typ	Beschreibung
dashboardUserAccessRight	DashboardUserAccessRight	Das Zugriffsrecht, das der Benutzer für das Dashboard hat (Berechtigungsstufe)
displayName	string	Anzeigename des Prinzipals
emailAddress	string	E-Mail-Adresse des Benutzers
graphId	string	Bezeichner des Prinzipals in Microsoft Graph. Nur für Administrator-APIs verfügbar.
identifier	string	Bezeichner des Prinzipals
principalType	PrincipalType	Der Prinzipaltyp
profile	ServicePrincipalProfile	Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
userType	string	Typ des Benutzers.

DashboardUserAccessRight

Enumeration

Das Zugriffsrecht, das der Benutzer für das Dashboard hat (Berechtigungsstufe)

Wert	Beschreibung
None	Keine Berechtigung für Inhalte im Dashboard
Read	Gewährt Lesezugriff auf Inhalte im Dashboard
ReadWrite	Gewährt Lese- und Schreibzugriff auf Inhalte im Dashboard
ReadReshare	Gewährt Lese- und Freigabezugriff auf Inhalte im Dashboard
ReadCopy	Gewährt Lese- und Kopierzugriff auf Inhalte im Dashboard
Owner	Gewährt Lese-, Schreib- und Freigabezugriff auf Inhalte im Bericht

PrincipalType

Enumeration

Der Prinzipaltyp

Wert	Beschreibung
None	Kein Prinzipaltyp. Wird für den Zugriff auf ganze Organisationsebene verwendet.
User	Benutzerprinzipaltyp
Group	Gruppenprinzipaltyp
App	Dienstprinzipaltyp

ServicePrincipalProfile

Objekt

Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.

Name	Typ	Beschreibung
displayName	string	Der Dienstprinzipalprofilname
id	string (uuid)	Die Dienstprinzipalprofil-ID

Subscription

Objekt

Ein E-Mail-Abonnement für ein Power BI-Element (z. B. einen Bericht oder ein Dashboard)

Name	Typ	Beschreibung
artifactDisplayName	string	Der Name des abonnierten Power BI-Elements (z. B. ein Bericht oder ein Dashboard)
artifactId	string (uuid)	Die ID des abonnierten Power BI-Elements (z. B. ein Bericht oder ein Dashboard)
artifactType	string	Der Typ des Power BI-Elements (z. B. ein Report, Dashboardoder Dataset)
attachmentFormat	string	Format des Berichts, der im E-Mail-Abonnement angefügt ist
endDate	string (date-time)	Enddatum und -uhrzeit des E-Mail-Abonnements
frequency	string	Die Häufigkeit des E-Mail-Abonnements
id	string (uuid)	Die Abonnement-ID
isEnabled	boolean	Gibt an, ob das E-Mail-Abonnement aktiviert ist.
linkToContent	boolean	Gibt an, ob ein Abonnementlink im E-Mail-Abonnement vorhanden ist.
previewImage	boolean	Gibt an, ob ein Screenshot des Berichts im E-Mail-Abonnement vorhanden ist.
startDate	string (date-time)	Startdatum und -uhrzeit des E-Mail-Abonnements
subArtifactDisplayName	string	Der Seitenname des abonnierten Power BI-Elements, wenn es sich um einen Bericht handelt.
title	string	Der App-Name
users	SubscriptionUser[]	Die Details der einzelnen E-Mail-Abonnenten. Bei Verwendung des Abrufen von Benutzerabonnements als Administrator API-Aufruf ist der zurückgegebene Wert ein leeres Array (NULL). Diese Eigenschaft wird aus der Nutzlastantwort in einer bevorstehenden Version entfernt. Sie können Abonnementinformationen in einem Power BI-Bericht oder -Dashboard abrufen, indem Sie die Abrufen von Berichtsabonnements als Administrator- oder Abrufen von Dashboardabonnements als Administrator API-Aufrufen verwenden.

SubscriptionUser

Objekt

Ein Power BI-E-Mail-Abonnementbenutzer

Name	Typ	Beschreibung
displayName	string	Anzeigename des Prinzipals
emailAddress	string	E-Mail-Adresse des Benutzers
graphId	string	Bezeichner des Prinzipals in Microsoft Graph. Nur für Administrator-APIs verfügbar.
identifier	string	Bezeichner des Prinzipals
principalType	PrincipalType	Der Prinzipaltyp
profile	ServicePrincipalProfile	Ein Power BI-Dienstprinzipalprofil. Nur für Power BI Embedded Multi-Mandantenlösungrelevant.
userType	string	Typ des Benutzers.