Apps - Get Dashboard

Referenz

Service:: 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	OK

Beispiele

Example

Sample Request

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

Sample Response

Status code:: 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 API namens, den Aufruferberechtigungen und der Verfügbarkeit von Daten in der Power BI-Datenbank ab.
DashboardUser	Ein Power BI-Benutzerzugriffsrecht für ein Dashboard
DashboardUserAccessRight	Das Zugriffsrecht, das der Benutzer für das Dashboard hat (Berechtigungsstufe)
PrincipalType	Der Prinzipaltyp
ServicePrincipalProfile	Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.
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

Ein Power BI-Dashboard. Die API gibt eine Teilmenge der folgenden Liste der Dashboardeigenschaften zurück. Die Teilmenge hängt von der API namens, 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	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 in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Abonnementinformationen für einen Power BI-Bericht abrufen, indem Sie berichtsabonnements abrufen als Admin API-Aufruf verwenden.
users	DashboardUser[]	(Leerer Wert) Die Details des Dashboardbenutzerzugriffs. Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Benutzerinformationen auf einem Power BI-Dashboard abrufen, indem Sie den Aufruf Dashboardbenutzer als Admin API abrufen oder den PostWorkspaceInfo-API-Aufruf mit dem `getArtifactUsers` Parameter verwenden.
webUrl	string	Die Web-URL des Dashboards

DashboardUser

Ein Power BI-Benutzerzugriffsrecht 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-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.
userType	string	Typ des Benutzers.

DashboardUserAccessRight

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

Name	Typ	Beschreibung
None	string	Keine Berechtigung für Inhalte im Dashboard
Owner	string	Gewährt Lese-, Schreib- und erneuten Zugriff auf Inhalte im Bericht
Read	string	Gewährt Lesezugriff auf Inhalte im Dashboard
ReadCopy	string	Gewährt Lese- und Kopierzugriff auf Inhalte im Dashboard
ReadReshare	string	Gewährt lese- und erneuten Zugriff auf Inhalte im Dashboard
ReadWrite	string	Gewährt Lese- und Schreibzugriff auf Inhalte im Dashboard

PrincipalType

Der Prinzipaltyp

Name	Typ	Beschreibung
App	string	Dienstprinzipaltyp
Group	string	Gruppenprinzipaltyp
None	string	Kein Prinzipaltyp. Verwenden Sie dies für den gesamten Zugriff auf Organisationsebene.
User	string	Benutzerprinzipaltyp

ServicePrincipalProfile

Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.

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

Subscription

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	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`, `Dashboard`oder `Dataset`)
attachmentFormat	string	Format des Berichts, der im E-Mail-Abonnement angefügt ist
endDate	string	Enddatum und -uhrzeit des E-Mail-Abonnements
frequency	string	Häufigkeit des E-Mail-Abonnements
id	string	Die Abonnement-ID
isEnabled	boolean	Ob das E-Mail-Abonnement aktiviert ist
linkToContent	boolean	Ob ein Abonnementlink im E-Mail-Abonnement vorhanden ist
previewImage	boolean	Ob ein Screenshot des Berichts im E-Mail-Abonnement vorhanden ist
startDate	string	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. Wenn Sie den API-Aufruf "Benutzerabonnements abrufen als Admin" verwenden, ist der zurückgegebene Wert ein leeres Array (NULL). Diese Eigenschaft wird in einer bevorstehenden Version aus der Nutzlastantwort entfernt. Sie können Abonnementinformationen für einen Power BI-Bericht oder ein Power BI-Dashboard abrufen, indem Sie die API-Aufrufe Berichtsabonnements als Admin abrufen oder Dashboardabonnements abrufen als Admin verwenden.

SubscriptionUser

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-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Lösung mit mehreren Mandanten.
userType	string	Typ des Benutzers.

Freigeben über