Freigeben über


Reports - Get Reports

Gibt eine Liste von Berichten aus Meinem Arbeitsbereich zurück.

Diese API gibt auch freigegebene Berichte und Berichte aus freigegebenen Apps zurück. Auf Berichte, die sich in freigegebenen Arbeitsbereichen befinden, kann mithilfe der API zum Abrufen von Berichten in Gruppen zugegriffen werden.

Da paginierte Berichte (RDL) kein Dataset enthalten, wird der Wert der Dataset-ID in der API-Antwort für paginierte Berichte nicht angezeigt.

Erforderlicher Bereich

Report.ReadWrite.All oder Report.Read.All

GET https://api.powerbi.com/v1.0/myorg/reports

Antworten

Name Typ Beschreibung
200 OK

Reports

OK

Beispiele

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/reports

Sample Response

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

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-Benutzerzugriffsrechteintrag für einen Bericht

ReportUserAccessRight

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

ServicePrincipalProfile

Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Mehrinstanzenlösung.

Subscription

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

SubscriptionUser

Ein Power BI-E-Mail-Abonnementbenutzer

PrincipalType

Der Prinzipaltyp

Name Typ Beschreibung
App

string

Dienstprinzipaltyp

Group

string

Gruppenprinzipaltyp

None

string

Kein Prinzipaltyp. Verwenden Sie für den Zugriff auf die gesamte organization ebene.

User

string

Benutzerprinzipaltyp

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.

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

Die Berichtsbeschreibung

embedUrl

string

Die Einbettungs-URL des Berichts

id

string

Die Berichts-ID

isOwnedByMe

boolean

Ermitteln Sie, ob der Bericht vom aktuellen Benutzer erstellt wird.

name

string

Der Name des Berichts

originalReportId

string

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 eine Dashboard). Diese Eigenschaft wird in einem bevorstehenden Release aus der Nutzlastantwort entfernt. Sie können Abonnementinformationen für einen Power BI-Bericht abrufen, indem Sie den API-Aufruf Zum Abrufen von Berichtsabonnements als Admin verwenden.

users

ReportUser[]

(Leerer Wert) Die Benutzerzugriffsdetails für einen Power BI-Bericht. Diese Eigenschaft wird in einem bevorstehenden Release aus der Nutzlastantwort entfernt. Sie können Benutzerinformationen für einen Power BI-Bericht abrufen, indem Sie den Aufruf "Berichtsbenutzer als Admin API abrufen" oder den API-Aufruf PostWorkspaceInfo mit dem getArtifactUsers -Parameter verwenden.

webUrl

string

Die Web-URL des Berichts

Reports

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

Name Typ Beschreibung
odata.context

string

OData-Kontext

value

Report[]

Die Berichtssammlung

ReportUser

Ein Power BI-Benutzerzugriffsrechteintrag 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-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Mehrinstanzenlösung.

reportUserAccessRight

ReportUserAccessRight

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

userType

string

Typ des Benutzers.

ReportUserAccessRight

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

Name Typ Beschreibung
None

string

Keine Berechtigung für Inhalte im Bericht

Owner

string

Gewährt Lese-, Schreib- und erneuten Zugriff auf Inhalte im Bericht

Read

string

Gewährt Lesezugriff auf Inhalte im Bericht

ReadCopy

string

Gewährt Lese- und Kopierzugriff auf Inhalte im Bericht

ReadReshare

string

Gewährt lese- und erneuten Zugriff auf Inhalte im Bericht

ReadWrite

string

Gewährt Lese- und Schreibzugriff auf Inhalte im Bericht

ServicePrincipalProfile

Ein Power BI-Dienst Prinzipalprofil. Nur relevant für Power BI Embedded Mehrinstanzenlösung.

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 eine 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. , ReportDashboardoder 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

Die 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 jedes E-Mail-Abonnenten. Wenn Sie den API-Aufruf Get User Subscriptions As Admin verwenden, ist der zurückgegebene Wert ein leeres Array (NULL). Diese Eigenschaft wird in einem bevorstehenden Release aus der Nutzlastantwort entfernt. Sie können Abonnementinformationen zu einem Power BI-Bericht oder Dashboard abrufen, indem Sie die API-Aufrufe "Berichtsabonnements als Admin abrufen" oder "Dashboardabonnements als Admin abrufen" 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 Mehrinstanzenlösung.

userType

string

Typ des Benutzers.