Reports - Export To File In Group

Service:

Power BI REST APIs

API Version:

v1.0

Exportiert den angegebenen Bericht aus dem angegebenen Arbeitsbereich in das angeforderte Dateiformat.

Die API wird asynchron ausgeführt. Wenn die API aufgerufen wird, wird ein Exportauftrag ausgelöst. Nachdem Sie einen Exportauftrag ausgelöst haben, verwenden Sie die GetExportToFileStatus-API, um den Auftrag status nachzuverfolgen. Weitere Informationen zum gesamten Flow: Exportieren von Power BI-Berichten und Exportieren paginierter Berichte

Berechtigungen

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

Erforderlicher Bereich

Alle folgenden Rollen:

• Report.ReadWrite.All oder Report.Read.All
• Dataset.ReadWrite.All oder Dataset.Read.All

Einschränkungen

Überprüfen Sie die Einschränkungen unter Power BI-Bericht in Datei exportieren und Paginierten Bericht in Datei exportieren.

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/reports/{reportId}/ExportTo

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
groupId	path	True	string uuid	Arbeitsbereich-ID
reportId	path	True	string uuid	Die Berichts-ID

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
format	True	FileFormat	Das angeforderte Format für die exportierte Datei
paginatedReportConfiguration		PaginatedReportExportConfiguration	Die Konfiguration, die zum Exportieren eines paginierten Berichts verwendet wird
powerBIReportConfiguration		PowerBIReportExportConfiguration	Die Konfiguration, die zum Exportieren eines Power BI-Berichts verwendet wird

Antworten

Name	Typ	Beschreibung
202 Accepted	Export	Akzeptiert

Definitionen

Name	Beschreibung
EffectiveIdentity	Definiert die Benutzeridentität und die Rollen. Weitere Informationen finden Sie unter Sicherheit auf Zeilenebene mit Power BI Embedded.
Export	Ein Objekt, das die Details und den aktuellen Status eines Exportauftrags in eine Datei beschreibt
ExportFilter	Ein Filter, der während des Exportvorgangs angewendet werden soll
ExportReportPage	Eine Konfiguration mit einer einzelnen Seite für die Exportanforderung
ExportReportRequest	Die Anforderung zum Exportieren in eine Datei
ExportReportSettings	In Dateianforderungseinstellungen exportieren
ExportState	Der aktuelle Status des Auftrags zum Exportieren in die Datei
FileFormat	Das angeforderte Format für die exportierte Datei
IdentityBlob	Ein Blob zum Angeben einer Identität. Nur für Datasets mit directQuery-Verbindung mit Azure SQL
PageBookmark	Das Lesezeichen, das auf eine einzelne Seite angewendet werden soll. Geben Sie Name oder Status an, aber nicht beides.
PaginatedReportExportConfiguration	Die Konfiguration des Exports in eine Datei für einen paginierten Bericht
ParameterValue	Datenvertrag für paginierte Berichtsparameter
PowerBIReportExportConfiguration	Die Konfiguration des Exports in eine Datei für einen Power BI-Bericht

EffectiveIdentity

Definiert die Benutzeridentität und die Rollen. Weitere Informationen finden Sie unter Sicherheit auf Zeilenebene mit Power BI Embedded.

Name	Typ	Beschreibung
auditableContext	string	Der überprüfbare EffectiveIdentity-Kontext. Wenn dieser Parameter bereitgestellt wird und nicht leer ist, aktiviert er die Überwachung von EffectiveIdentity, und sein Wert wird auf den Benutzernamen im Überwachungsdatensatz festgelegt. Andernfalls wird der EffectiveIdentity-Kontext im GenerateToken-Überwachungsdatensatz weggelassen.
customData	string	Benutzerdefinierte Daten , die zum Anwenden von Sicherheitsregeln auf Zeilenebene verwendet werden. Wird nur für Liveverbindungen mit Azure Analysis Services- und Cloudmodellen unterstützt.
datasets	string[]	Ein Array von Datasets, für die diese Identität gilt
identityBlob	IdentityBlob	Ein Blob, das eine Identität angibt. Wird nur für Datasets mit einer DirectQuery-Verbindung mit Azure SQL unterstützt.
reports	string[]	Ein Array von Berichten, für die diese Identität gilt. Wird nur für paginierte Berichte unterstützt.
roles	string[]	Ein Array von RLS-Rollen (Row-Level Security) in einem Token, das RLS-Regeln anwendet. Eine Identität kann bis zu 50 Rollen enthalten. Eine Rolle kann ein beliebiges Zeichen mit Ausnahme ,von enthalten, und ihre Länge darf 50 Zeichen nicht überschreiten.
username	string	Der effektive Benutzername in einem Token, das Sicherheitsregeln auf Zeilenebene anwendet. Bei einem lokalen Modell kann der Benutzername alphanumerisch oder eines der folgenden Zeichen .enthalten: , -, _, #!, ^, ~, \\, , @. Bei Cloudmodellen kann der Benutzername ein beliebiges ASCII-Zeichen enthalten. Bei beiden Modellen darf die Länge des Benutzernamens 256 Zeichen nicht überschreiten, und der Benutzername darf keine Leerzeichen enthalten.

Export

Ein Objekt, das die Details und den aktuellen Status eines Exportauftrags in eine Datei beschreibt

Name	Typ	Beschreibung
ResourceFileExtension	string	Die Erweiterung der exportierten Datei
createdDateTime	string	Startdatum und -uhrzeit des Auftrags zum Exportieren in die Datei
expirationTime	string	Ablaufdatum und -uhrzeit der Abruf-URL
id	string	Die Auftrags-ID für den Export in die Datei
lastActionDateTime	string	Datum und Uhrzeit der letzten Änderung am Export in den Dateiauftrag
percentComplete	integer	Auftragsfortschritt als Prozentsatz
reportId	string	Die ID des exportierten Berichts
reportName	string	Der Name des exportierten Berichts
resourceLocation	string	Die Abruf-URL für die exportierte Datei
status	ExportState	Der aktuelle Status des Auftrags zum Exportieren in die Datei

ExportFilter

Ein Filter, der während des Exportvorgangs angewendet werden soll

Name	Typ	Beschreibung
filter	string	Der anzuwendende Filter. Informationen zur Filtersyntax finden Sie unter Filtern eines Berichts.

ExportReportPage

Eine Konfiguration mit einer einzelnen Seite für die Exportanforderung

Name	Typ	Beschreibung
bookmark	PageBookmark	Das lesezeichen, das auf der Seite angewendet werden soll
pageName	string	Der Seitenname
visualName	string	Der Name des zu exportierenden Visuals. Geben Sie einen Namen an, falls nur ein einzelnes Visual von dieser Seite exportiert wird.

ExportReportRequest

Die Anforderung zum Exportieren in eine Datei

Name	Typ	Beschreibung
format	FileFormat	Das angeforderte Format für die exportierte Datei
paginatedReportConfiguration	PaginatedReportExportConfiguration	Die Konfiguration, die zum Exportieren eines paginierten Berichts verwendet wird
powerBIReportConfiguration	PowerBIReportExportConfiguration	Die Konfiguration, die zum Exportieren eines Power BI-Berichts verwendet wird

ExportReportSettings

In Dateianforderungseinstellungen exportieren

Name	Typ	Beschreibung
includeHiddenPages	boolean	Gibt an, ob ausgeblendete Seiten beim Exportieren eines gesamten Berichts eingeschlossen werden sollen. Wenn nicht angegeben, besteht das Standardverhalten darin, ausgeblendete Seiten auszuschließen. Diese Eigenschaft wird ignoriert, wenn bestimmte Seiten exportiert werden.
locale	string	Das anzuwendende Gebietsschema

ExportState

Der aktuelle Status des Auftrags zum Exportieren in die Datei

Name	Typ	Beschreibung
Failed	string	Fehler beim Export in dateiauftrag
NotStarted	string	Der Export in dateiauftrag wurde nicht gestartet
Running	string	Der Export in Dateiauftrag wird ausgeführt.
Succeeded	string	Der Export in Dateiauftrag wurde erfolgreich abgeschlossen.
Undefined	string	Der Status des Dateiexportauftrags ist nicht definiert.

FileFormat

Das angeforderte Format für die exportierte Datei

Name	Typ	Beschreibung
ACCESSIBLEPDF	string	Barrierefreie PDF (nur für paginierte Berichte unterstützt)
CSV	string	CSV (nur für paginierte Berichte unterstützt)
DOCX	string	Microsoft Word (nur für paginierte Berichte unterstützt)
IMAGE	string	BMP-, EMF-, GIF-, JPEG-, PNG- oder TIFF-Bildformate (nur für paginierte Berichte unterstützt)
MHTML	string	MHTML (nur für paginierte Berichte unterstützt)
PDF	string	PDF
PNG	string	PNG (nur für Power BI-Berichte unterstützt)
PPTX	string	Microsoft PowerPoint
XLSX	string	Microsoft Excel (nur für paginierte Berichte unterstützt)
XML	string	XML (nur für paginierte Berichte unterstützt)

IdentityBlob

Ein Blob zum Angeben einer Identität. Nur für Datasets mit directQuery-Verbindung mit Azure SQL

Name	Typ	Beschreibung
value	string	Ein OAuth 2.0-Zugriffstoken für Azure SQL

PageBookmark

Das Lesezeichen, das auf eine einzelne Seite angewendet werden soll. Geben Sie Name oder Status an, aber nicht beides.

Name	Typ	Beschreibung
name	string	Der Name des Lesezeichens
state	string	Der Textmarkenstatus

PaginatedReportExportConfiguration

Die Konfiguration des Exports in eine Datei für einen paginierten Bericht

Name	Typ	Beschreibung
formatSettings	object	Ein Wörterbuch mit Formateinstellungen. Die Schlüssel sind die Namen der Geräteinformationseigenschaft für das angeforderte Dateiformat.
identities	EffectiveIdentity[]	Die einzelne Identität, die beim Exportieren eines Berichts verwendet werden soll. Erforderlich, wenn ein Bericht ein Power BI-Dataset oder eine Azure Analysis Services Datenquelle verwendet.
parameterValues	ParameterValue[]	Eine Liste von Berichtsparametern

ParameterValue

Datenvertrag für paginierte Berichtsparameter

Name	Typ	Beschreibung
name	string	Der Parametername
value	string	Der Parameterwert

PowerBIReportExportConfiguration

Die Konfiguration des Exports in eine Datei für einen Power BI-Bericht

Name	Typ	Beschreibung
datasetToBind	string	Die Dataset-ID, mit der der Bericht exportiert werden soll. Nur erforderlich, wenn sie mit einem anderen Dataset als dem Standarddataset des Berichts exportiert werden.
defaultBookmark	PageBookmark	Ein Standardlesezeichen, das auf alle Seiten angewendet werden soll, die nicht über ein bestimmtes Lesezeichen verfügen
identities	EffectiveIdentity[]	Eine Liste der Identitäten, die für Sicherheitsregeln auf Zeilenebene verwendet werden sollen.
pages	ExportReportPage[]	Eine Liste der zu exportierenden Seiten und deren Eigenschaften. Dieselbe Seite wird möglicherweise mehrmals mit unterschiedlichen Visuals angezeigt.
reportLevelFilters	ExportFilter[]	Eine Liste der anzuwendenden Filter auf Berichtsebene. Derzeit wird nur ein Filter unterstützt.
settings	ExportReportSettings	Die Einstellungen, die für den Export in dateiauftrag angewendet werden sollen