Reports - Export To File

Referenz

Service:: Power BI REST APIs

API Version:: v1.0

Exportiert den angegebenen Bericht aus "Mein Arbeitsbereich" in das angeforderte Dateiformat.

Die API wird asynchron ausgeführt. Wenn die API aufgerufen wird, löst sie einen Exportauftrag aus. Verwenden Sie nach dem Auslösen eines Exportauftrags die GetExportToFileStatus-API, um den Auftrag status nachzuverfolgen. Weitere Informationen zum gesamten Flow: Exportieren von Power BI-Berichten und Exportieren paginierter Berichte

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 Exportieren des Power BI-Berichts in die Datei und Exportieren eines paginierten Berichts in eine Datei.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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 Zum Exportieren eines paginierten Berichts verwendete Konfiguration
powerBIReportConfiguration		PowerBIReportExportConfiguration	Die Zum Exportieren eines Power BI-Berichts verwendete Konfiguration

Antworten

Name	Typ	Beschreibung
202 Accepted	Export	Akzeptiert

Definitionen

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

EffectiveIdentity

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

Name	Typ	Beschreibung
auditableContext	string	Der überprüfbare Kontext von EffectiveIdentity. Wenn dieser Parameter angegeben 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 aus dem GenerateToken-Überwachungsdatensatz weggelassen.
customData	string	Benutzerdefinierte Daten , die zum Anwenden von Sicherheitsregeln auf Zeilenebene verwendet werden. Wird nur für die Liveverbindung 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. Nur für paginierte Berichte unterstützt.
roles	string[]	Ein Array von Sicherheitsrollen auf Zeilenebene (RLS) 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 Benutzernamenlänge nicht mehr als 256 Zeichen betragen, und der Benutzername darf keine Leerzeichen enthalten.

Export

Ein Objekt, das die Details und den aktuellen Zustand eines Export-in-Dateiauftrags beschreibt

Name	Typ	Beschreibung
ResourceFileExtension	string	Die Erweiterung der exportierten Datei
createdDateTime	string	Startdatum und -uhrzeit des Export-in-Dateiauftrags
expirationTime	string	Ablaufdatum und -uhrzeit der Abruf-URL
id	string	Die Id des Exportauftrags in Datei
lastActionDateTime	string	Datum und Uhrzeit der letzten Änderung am Export in Dateiauftrag
percentComplete	integer	Auftragsfortschritt in Prozent
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 Export-in-Dateiauftrags

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 Einzelseitenkonfiguration 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 Exportanforderung in die Datei

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

ExportReportSettings

Exportieren in Dateianforderungseinstellungen

Name	Typ	Beschreibung
includeHiddenPages	boolean	Gibt an, ob beim Exportieren eines gesamten Berichts ausgeblendete Seiten 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 Export-in-Dateiauftrags

Name	Typ	Beschreibung
Failed	string	Fehler beim Exportieren in den 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 Export-in-Dateiauftrags 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 einer 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 Zustand an, aber nicht beides.

Name	Typ	Beschreibung
name	string	Der Lesezeichenname
state	string	Der Textmarkenstatus

PaginatedReportExportConfiguration

Die Export-in-Dateikonfiguration 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 Export-in-Dateikonfiguration 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 Standard-Lesezeichen, das auf alle Seiten angewendet werden soll, die nicht über ein bestimmtes Lesezeichen verfügen
identities	EffectiveIdentity[]	Eine Liste von Identitäten, die für Sicherheitsregeln auf Zeilenebene verwendet werden sollen
pages	ExportReportPage[]	Eine Liste der zu exportierenden Seiten und deren Eigenschaften. Dieselbe Seite kann mit unterschiedlichen Visuals mehr als einmal angezeigt werden.
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

Freigeben über