Reports - Get Reports In Group

Dienst:

Power BI REST APIs

API-Version:

v1.0

Gibt eine Liste von Berichten aus dem angegebenen Arbeitsbereich zurück.

Da paginierte Berichte (RDL) nicht über ein Dataset verfügen, wird der Dataset-ID-Wert in der API-Antwort für paginierte Berichte nicht angezeigt.

Erlaubnisse

Dieser API-Aufruf kann von einem Dienstprinzipalprofil aufgerufen werden. Weitere Informationen finden Sie unter: Dienstprinzipalprofile in Power BI Embedded.

Erforderlicher Bereich

Report.ReadWrite.All oder Report.Read.All

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/reports

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
groupId	path	True	string (uuid)	Arbeitsbereich-ID

Antworten

Name	Typ	Beschreibung
200 OK	Reports	OKAY

Beispiele

Example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/5b218778-e7a5-4d73-8187-f10824047715",
      "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48"
    }
  ]
}

Definitionen

Name	Beschreibung
PrincipalType	Der Prinzipaltyp
Report	Ein Power BI-Bericht. Die API gibt eine Teilmenge der folgenden Liste der Berichtseigenschaften zurück. Die Teilmenge hängt von der aufgerufenen API, den Aufruferberechtigungen und der Verfügbarkeit von Daten in der Power BI-Datenbank ab.
Reports	Der OData-Antwortwrapper für eine Power BI-Berichtssammlung
ReportUser	Ein Power BI-Benutzerzugriffsrecht für einen Bericht
ReportUserAccessRight	Das Zugriffsrecht, das der Benutzer für den Bericht hat (Berechtigungsstufe)
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

PrincipalType

Enumeration

Der Prinzipaltyp

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

Report

Objekt

Ein Power BI-Bericht. Die API gibt eine Teilmenge der folgenden Liste der Berichtseigenschaften 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 der Bericht zu einer App gehört
datasetId	string	Die Dataset-ID des Berichts
description	string	Beschreibung des Berichts
embedUrl	string	Die Einbettungs-URL des Berichts
id	string (uuid)	Die Berichts-ID
isOwnedByMe	boolean	Gibt an, ob der aktuelle Benutzer entweder eine Kopie des Berichts ändern oder erstellen kann.
name	string	Der Name des Berichts. App-Berichte beginnen mit dem Präfix [App].
originalReportId	string (uuid)	Die tatsächliche Berichts-ID, wenn der Arbeitsbereich als App veröffentlicht wird.
reportType	enum: PaginatedReport PowerBIReport	Der Berichtstyp
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	ReportUser[]	(Leerer Wert) Der Benutzer greift auf Details für einen Power BI-Bericht zu. Diese Eigenschaft wird aus der Nutzlastantwort in einer bevorstehenden Version entfernt. Sie können Benutzerinformationen in einem Power BI-Bericht abrufen, indem Sie die Abrufen von Berichtsbenutzern als Administrator- API-Aufruf oder den PostWorkspaceInfo API-Aufruf mit dem parameter getArtifactUsers verwenden.
webUrl	string	Die Web-URL des Berichts

Reports

Objekt

Der OData-Antwortwrapper für eine Power BI-Berichtssammlung

Name	Typ	Beschreibung
@odata.context	string	OData-Kontext
value	Report[]	Die Berichtssammlung

ReportUser

Objekt

Ein Power BI-Benutzerzugriffsrecht für einen Bericht

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.
reportUserAccessRight	ReportUserAccessRight	Das Zugriffsrecht, das der Benutzer für den Bericht hat (Berechtigungsstufe)
userType	string	Typ des Benutzers.

ReportUserAccessRight

Enumeration

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

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

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.