Reports - Export To File

Dienst:

Power BI REST APIs

API-Version:

v1.0

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

Die API ist asynchron. Wenn die API aufgerufen wird, löst sie einen Exportauftrag aus. Verwenden Sie nach dem Auslösen eines Exportauftrags GetExportToFileStatus-API, um den Auftragsstatus nachzuverfolgen. Weitere Informationen zum gesamten Ablauf: Exportieren von Power BI-Berichten und Export paginierte 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 in Power BI-Bericht exportieren, um und Export paginated report to file.

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 Konfiguration zum Exportieren eines paginierten Berichts
powerBIReportConfiguration		PowerBIReportExportConfiguration	Die Konfiguration zum Exportieren eines Power BI-Berichts

Antworten

Name	Typ	Beschreibung
202 Accepted	Export	Angenommen

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 Status eines Export-in-Dateiauftrags beschreibt
ExportFilter	Ein Filter, der während des Exportvorgangs angewendet werden soll
ExportReportPage	Eine Konfiguration einer einzelnen Seite für die Exportanforderung
ExportReportRequest	Der Export in Dateianforderung
ExportReportSettings	In Dateianforderungseinstellungen exportieren
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 unterstützt
PageBookmark	Die Textmarke, die auf eine einzelne Seite angewendet werden soll. Geben Sie den Namen oder den Status an, aber nicht beides.
PaginatedReportExportConfiguration	Die Export-in-Dateikonfiguration für einen paginierten Bericht
ParameterValue	Datenkontrakt für paginierte Berichtsparameter
PowerBIReportExportConfiguration	Die Export-in-Dateikonfiguration für einen Power BI-Bericht

EffectiveIdentity

Objekt

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

Name	Typ	Beschreibung
auditableContext	string	Der Auditable-Kontext "EffectiveIdentity". Wenn dieser Parameter angegeben und nicht leer ist, wird die Überwachung der EffectiveIdentity aktiviert, und der 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 live-Verbindungen mit Azure Analysis Services-Modellen und Cloudmodellen unterstützt.
datasets	string[]	Ein Array von Datasets, für die diese Identität gilt
identityBlob	IdentityBlob	Ein Blob, das eine Identitätangibt. 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 Rollen auf Zeilenebene (RLS) innerhalb eines Tokens, das RLS-Regeln anwendet. Eine Identität kann bis zu 50 Rollen enthalten. Eine Rolle kann ein beliebiges Zeichen mit Ausnahme von ,enthalten, und seine Länge darf 50 Zeichen nicht überschreiten.
username	string	Der effektive Benutzername in einem Token, das Sicherheitsregeln auf Zeilenebene anwendet. Für ein lokales Modell kann der Benutzername alphanumerisch oder eines der folgenden Zeichen ., -, _, !, #, ^, ~, \\, @. Bei Cloudmodellen kann der Benutzername ein beliebiges ASCII-Zeichen enthalten. Für beide Modelle darf die Länge des Benutzernamens 256 Zeichen nicht überschreiten, und der Benutzername darf keine Leerzeichen enthalten.

Export

Objekt

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

Name	Typ	Beschreibung
createdDateTime	string (date-time)	Das Startdatum und die Startzeit des Export-in-Dateiauftrags
expirationTime	string (date-time)	Ablaufdatum und -uhrzeit der Abruf-URL
id	string	Die Export-in-Dateiauftrags-ID
lastActionDateTime	string (date-time)	Das Datum und die Uhrzeit der letzten Änderung des Export-in-Dateiauftrags
percentComplete	integer (int32) minimum: 0 maximum: 100	Auftragsfortschritt als Prozentsatz
reportId	string (uuid)	Die ID des exportierten Berichts
reportName	string	Der Name des exportierten Berichts
resourceFileExtension	string	Die Erweiterung der exportierten Datei
resourceLocation	string	Die Abruf-URL für die exportierte Datei
status	ExportState	Der aktuelle Status des Export-in-Dateiauftrags

ExportFilter

Objekt

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

Objekt

Eine Konfiguration einer einzelnen Seite für die Exportanforderung

Name	Typ	Beschreibung
bookmark	PageBookmark	Die Textmarke, die auf der Seite angewendet werden soll
pageName	string	Der Seitenname
visualName	string	Der Name des zu exportierenden visuellen Elements. Geben Sie einen Namen an, falls nur ein einzelnes visuelles Element von dieser Seite exportiert wird.

ExportReportRequest

Objekt

Der Export in Dateianforderung

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

ExportReportSettings

Objekt

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 zu übernehmende Gebietsschema

ExportState

Enumeration

Der aktuelle Status des Export-in-Dateiauftrags

Wert	Beschreibung
Failed	Fehler beim Exportieren in dateiauftrag
NotStarted	Der Export in Dateiauftrag wurde nicht gestartet.
Running	Der Export in Dateiauftrag wird ausgeführt.
Succeeded	Der Export in Dateiauftrag wurde erfolgreich abgeschlossen.
Undefined	Der Status des Export-in-Dateiauftrags ist nicht definiert.

FileFormat

Enumeration

Das angeforderte Format für die exportierte Datei

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

IdentityBlob

Objekt

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

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

PageBookmark

Objekt

Die Textmarke, die auf eine einzelne Seite angewendet werden soll. Geben Sie den Namen oder den Status an, aber nicht beides.

Name	Typ	Beschreibung
name	string	Der Name der Textmarke
state	string	Der Textmarkenstatus

PaginatedReportExportConfiguration

Objekt

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.
locale	string	Das zu übernehmende Gebietsschema
parameterValues	ParameterValue[]	Eine Liste der Berichtsparameter

ParameterValue

Objekt

Datenkontrakt für paginierte Berichtsparameter

Name	Typ	Beschreibung
name	string	Der Parametername
value	string	Der Parameterwert

PowerBIReportExportConfiguration

Objekt

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 Standard-Dataset des Berichts exportiert werden.
defaultBookmark	PageBookmark	Eine Standardmarke, die auf allen Seiten angewendet werden soll, die nicht über eine bestimmte Textmarke 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 kann mehrmals mit unterschiedlichen visuellen Elementen 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