Reports - Export To File In Group

Služba:: Power BI REST APIs

Verze rozhraní API:: v1.0

Exportuje zadanou sestavu ze zadaného pracovního prostoru do požadovaného formátu souboru .

Rozhraní API je asynchronní. Když se rozhraní API zavolá, aktivuje úlohu exportu. Po aktivaci úlohy exportu použijte k sledování stavu úlohy rozhraní API GetExportToFileStatus. Přečtěte si další informace o celém toku: Export sestav Power BI a Export stránkovaných sestav

Dovolení

Toto volání rozhraní API může volat instanční profil. Další informace najdete v tématu: profily instančního objektu v Power BI Embedded.

Požadovaný obor

Všechny tyto možnosti:

Report.ReadWrite.All nebo Report.Read.All
Dataset.ReadWrite.All nebo Dataset.Read.All

Omezení

Zkontrolujte omezení v Export sestavy Power BI do souboru a Export stránkované sestavy do souboru.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
groupId	path	True	string (uuid)	ID pracovního prostoru
reportId	path	True	string (uuid)	ID sestavy

Text požadavku

Name	Vyžadováno	Typ	Description
format	True	FileFormat	Požadovaný formát exportovaného souboru
paginatedReportConfiguration		PaginatedReportExportConfiguration	Konfigurace použitá k exportu stránkované sestavy
powerBIReportConfiguration		PowerBIReportExportConfiguration	Konfigurace použitá k exportu sestavy Power BI

Odpovědi

Name	Typ	Description
202 Accepted	Export	Přijato

Definice

Name	Description
EffectiveIdentity	Definuje identitu a role uživatele. Další informace najdete v tématu zabezpečení na úrovni řádků pomocíPower BI Embedded .
Export	Objekt popisující podrobnosti a aktuální stav úlohy exportu do souboru
ExportFilter	Filtr, který se má použít během operace exportu
ExportReportPage	Konfigurace jedné stránky pro požadavek na export
ExportReportRequest	Žádost o export do souboru
ExportReportSettings	Export do nastavení žádosti o soubor
ExportState	Aktuální stav úlohy exportu do souboru
FileFormat	Požadovaný formát exportovaného souboru
IdentityBlob	Objekt blob pro zadání identity. Podporuje se jenom u datových sad s připojením DirectQuery k Azure SQL.
PageBookmark	Záložka, která se použije na jedné stránce. Zadejte název nebo stav, ale ne obojí.
PaginatedReportExportConfiguration	Konfigurace exportu do souboru pro stránkovanou sestavu
ParameterValue	Kontrakt dat pro parametry stránkované sestavy
PowerBIReportExportConfiguration	Konfigurace exportu do souboru pro sestavu Power BI

EffectiveIdentity

Objekt

Definuje identitu a role uživatele. Další informace najdete v tématu zabezpečení na úrovni řádků pomocíPower BI Embedded .

Name	Typ	Description
auditableContext	string	Auditovatelný kontext EffectiveIdentity. Pokud je tento parametr zadaný a není prázdný, povolí auditování EffectiveIdentity a jeho hodnota se nastaví na uživatelské jméno v záznamu auditu. V opačném případě bude kontext EffectiveIdentity vynechán ze záznamu auditu GenerateToken.
customData	string	vlastních dat, která slouží k použití pravidel zabezpečení na úrovni řádků. Podporuje se pouze živé připojení k modelům azure Analysis Services a cloudovým modelům.
datasets	string[]	Pole datových sad, pro které se tato identita vztahuje
identityBlob	IdentityBlob	Objekt blob, který určuje identity. Podporuje se jenom u datových sad s připojením DirectQuery k Azure SQL.
reports	string[]	Pole sestav, pro které tato identita platí. Podporuje se jenom pro stránkované sestavy.
roles	string[]	Pole rolí zabezpečení na úrovni řádků (RLS) v tokenu, který používá pravidla zabezpečení na úrovni řádků. Identita může obsahovat až 50 rolí. Role může obsahovat libovolný znak kromě `,`a jeho délka nesmí překročit 50 znaků.
username	string	Efektivní uživatelské jméno v tokenu, které používá pravidla zabezpečení na úrovni řádků. U místního modelu může uživatelské jméno obsahovat alfanumerické nebo libovolné z následujících znaků `.`, `-`, `_`, `!`, `#`, `^`, `~`, `\\`, `@`. U cloudových modelů může uživatelské jméno obsahovat libovolný znak ASCII. U obou modelů nesmí délka uživatelského jména překročit 256 znaků a uživatelské jméno nesmí obsahovat mezery.

Export

Objekt

Objekt popisující podrobnosti a aktuální stav úlohy exportu do souboru

Name	Typ	Description
createdDateTime	string (date-time)	Počáteční datum a čas úlohy exportu do souboru
expirationTime	string (date-time)	Datum a čas vypršení platnosti adresy URL pro načtení
id	string	ID úlohy exportu do souboru
lastActionDateTime	string (date-time)	Datum a čas poslední změny úlohy exportu do souboru
percentComplete	integer (int32) minimum: 0 maximum: 100	Průběh úlohy jako procento
reportId	string (uuid)	ID exportované sestavy
reportName	string	Název exportované sestavy
resourceFileExtension	string	Přípona exportovaného souboru
resourceLocation	string	Adresa URL pro načtení exportovaného souboru
status	ExportState	Aktuální stav úlohy exportu do souboru

ExportFilter

Objekt

Filtr, který se má použít během operace exportu

Name	Typ	Description
filter	string	Filtr, který se má použít. Informace o syntaxi filtru najdete v tématu Filtrování sestavy.

ExportReportPage

Objekt

Konfigurace jedné stránky pro požadavek na export

Name	Typ	Description
bookmark	PageBookmark	Záložka, která se má použít na stránce
pageName	string	Název stránky
visualName	string	Název vizuálu, který se má exportovat. Zadejte název, pokud se exportuje jenom jeden vizuál z této stránky.

ExportReportRequest

Objekt

Žádost o export do souboru

Name	Typ	Description
format	FileFormat	Požadovaný formát exportovaného souboru
paginatedReportConfiguration	PaginatedReportExportConfiguration	Konfigurace použitá k exportu stránkované sestavy
powerBIReportConfiguration	PowerBIReportExportConfiguration	Konfigurace použitá k exportu sestavy Power BI

ExportReportSettings

Objekt

Export do nastavení žádosti o soubor

Name	Typ	Description
includeHiddenPages	boolean	Zda zahrnout skryté stránky při exportu celé sestavy. Pokud není k dispozici, výchozím chováním je vyloučit skryté stránky. Tato vlastnost bude ignorována při exportu konkrétních stránek.
locale	string	Národní prostředí, které se má použít

ExportState

Výčet

Aktuální stav úlohy exportu do souboru

Hodnota	Description
Undefined	Stav úlohy exportu do souboru není definován.
NotStarted	Úloha exportu do souboru se nespustí.
Running	Úloha exportu do souboru je spuštěná.
Succeeded	Úloha exportu do souboru byla úspěšně dokončena.
Failed	Úloha exportu do souboru selhala.

FileFormat

Výčet

Požadovaný formát exportovaného souboru

Hodnota	Description
PPTX	Microsoft PowerPoint
PDF	soubor PDF
PNG	PNG (podporuje se jenom pro sestavy Power BI)
IMAGE	BMP, EMF, GIF, JPEG, PNG nebo TIFF formát obrázku (podporuje se jenom pro stránkované sestavy)
XLSX	Microsoft Excel (podporuje se jenom pro stránkované sestavy)
DOCX	Microsoft Word (podporuje se pouze pro stránkované sestavy)
CSV	CSV (podporuje se jenom pro stránkované sestavy)
XML	XML (podporováno pouze pro stránkované sestavy)
MHTML	MHTML (podporuje se pouze pro stránkované sestavy)
ACCESSIBLEPDF	Přístupný PDF (podporuje se jenom pro stránkované sestavy)

IdentityBlob

Objekt

Objekt blob pro zadání identity. Podporuje se jenom u datových sad s připojením DirectQuery k Azure SQL.

Name	Typ	Description
value	string	Přístupový token OAuth 2.0 pro Azure SQL

PageBookmark

Objekt

Záložka, která se použije na jedné stránce. Zadejte název nebo stav, ale ne obojí.

Name	Typ	Description
name	string	Název záložky
state	string	Stav záložky

PaginatedReportExportConfiguration

Objekt

Konfigurace exportu do souboru pro stránkovanou sestavu

Name	Typ	Description
formatSettings	object	Slovník nastavení formátu. Klíče jsou názvy vlastností informací o zařízení pro požadovaný formát souboru.
identities	EffectiveIdentity[]	Jedna identita, která se má použít při exportu sestavy. Vyžaduje se, když sestava používá datovou sadu Power BI nebo zdroj dat Azure Analysis Services.
locale	string	Národní prostředí, které se má použít
parameterValues	ParameterValue[]	Seznam parametrů sestavy

ParameterValue

Objekt

Kontrakt dat pro parametry stránkované sestavy

Name	Typ	Description
name	string	Název parametru
value	string	Hodnota parametru

PowerBIReportExportConfiguration

Objekt

Konfigurace exportu do souboru pro sestavu Power BI

Name	Typ	Description
datasetToBind	string	ID datové sady pro export sestavy. Je potřeba jenom v případě, že se exportuje s jinou datovou sadou než výchozí datovou sadou sestavy.
defaultBookmark	PageBookmark	Výchozí záložka, která se použije na všech stránkách, které nemají konkrétní záložku
identities	EffectiveIdentity[]	Seznam identit, které se mají použít pro pravidla zabezpečení na úrovni řádků
pages	ExportReportPage[]	Seznam stránek pro export a jejich vlastnosti Stejná stránka se může zobrazit více než jednou s různými vizuály.
reportLevelFilters	ExportFilter[]	Seznam filtrů na úrovni sestavy, které se mají použít. V současné době se podporuje jenom jeden filtr.
settings	ExportReportSettings	Nastavení, která se mají použít pro úlohu exportu do souboru

Sdílet prostřednictvím

Reports - Export To File In Group

Dovolení

Požadovaný obor

Omezení

Parametry identifikátoru URI

Text požadavku

Odpovědi

Definice

EffectiveIdentity

Export

ExportFilter

ExportReportPage

ExportReportRequest

ExportReportSettings

ExportState

FileFormat

IdentityBlob

PageBookmark

PaginatedReportExportConfiguration

ParameterValue

PowerBIReportExportConfiguration