Sdílet prostřednictvím

Reports - Export To File

  • Reference
Service:
Power BI REST APIs
API Version:
v1.0

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

Rozhraní API je asynchronní. Při volání rozhraní API se aktivuje úloha exportu. Po aktivaci úlohy exportu pomocí rozhraní API GetExportToFileStatus sledujte stav úlohy. Další informace o celém toku: Export sestav Power BI a Export stránkovaných sestav

Požadovaný obor

Všechno z tohoto:

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

Omezení

Projděte si omezení v tématu Export sestavy Power BI do souboru a Export stránkované sestavy do souboru. 

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
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ů s 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 žádost o export
ExportReportRequest

Žádost o export do souboru
ExportReportSettings

Nastavení žádosti o export do souboru
ExportState

Aktuální stav úlohy exportu do souboru
FileFormat

Požadovaný formát exportovaného souboru
IdentityBlob

Objekt blob pro zadání identity. Podporováno pouze pro datové sady s připojením DirectQuery k Azure SQL
PageBookmark

Záložka, která se má použít 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

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

Name Typ Description
auditableContext

string

Auditovatelný kontext EffectiveIdentity. Pokud je tento parametr zadaný a není prázdný, povolí auditování hodnoty EffectiveIdentity a jeho hodnota se nastaví na uživatelské jméno v záznamu auditu. V opačném případě se kontext EffectiveIdentity ze záznamu auditu GenerateToken vynechá.
customData

string

Vlastní data , která se používají k použití pravidel zabezpečení na úrovni řádků. Podporováno pouze pro ž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 identitu. Podporováno pouze u datových sad s připojením DirectQuery k Azure SQL.
reports

string[]

Pole sestav, pro které se tato identita vztahuje. Podporováno pouze pro stránkované sestavy.
roles

string[]

Pole rolí zabezpečení na úrovni řádků (RLS) v rámci tokenu, který používá pravidla zabezpečení na úrovni řádků. Identita může obsahovat až 50 rolí. Role může obsahovat libovolný znak s výjimkou ,a její délka nesmí překročit 50 znaků.
username

string

Platné uživatelské jméno v tokenu, který používá pravidla zabezpečení na úrovni řádků. V případě místního modelu může uživatelské jméno obsahovat alfanumerické znaky nebo některý 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 by nemělo obsahovat mezery.

Export

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

Name Typ Description
ResourceFileExtension

string

Přípona exportovaného souboru
createdDateTime

string

Počáteční datum a čas úlohy exportu do souboru
expirationTime

string

Datum a čas vypršení platnosti adresy URL pro načtení
id

string

ID úlohy exportu do souboru
lastActionDateTime

string

Datum a čas poslední změny úlohy exportu do souboru
percentComplete

integer

Průběh úlohy v procentech
reportId

string

ID exportované sestavy
reportName

string

Název exportované sestavy
resourceLocation

string

Adresa URL pro načtení exportovaného souboru
status

ExportState

Aktuální stav úlohy exportu do souboru

ExportFilter

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

Konfigurace jedné stránky pro žádost o 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ý chcete exportovat. Zadejte název pro případ, že se exportuje jenom jeden vizuál z této stránky.

ExportReportRequest

Žá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

Nastavení žádosti o export do souboru

Name Typ Description
includeHiddenPages

boolean

Jestli se mají při exportu celé sestavy zahrnout skryté stránky. Pokud není k dispozici, výchozím chováním je vyloučení skrytých stránek. Tato vlastnost bude při exportu konkrétních stránek ignorována.
locale

string

Národní prostředí, které se má použít

ExportState

Aktuální stav úlohy exportu do souboru

Name Typ Description
Failed

string

Úloha exportu do souboru se nezdařila.
NotStarted

string

Úloha exportu do souboru se nespustí
Running

string

Úloha exportu do souboru je spuštěná.
Succeeded

string

Úloha exportu do souboru se úspěšně dokončila.
Undefined

string

Stav úlohy exportu do souboru není definován.

FileFormat

Požadovaný formát exportovaného souboru

Name Typ Description
ACCESSIBLEPDF

string

Formát PDF s podporou přístupnosti (podporováno pouze pro stránkované sestavy)
CSV

string

CSV (podporuje se jenom pro stránkované sestavy)
DOCX

string

Microsoft Word (podporováno pouze pro stránkované sestavy)
IMAGE

string

Formáty obrázků BMP, EMF, GIF, JPEG, PNG nebo TIFF (podporované jenom pro stránkované sestavy)
MHTML

string

MHTML (podporováno pouze pro stránkované sestavy)
PDF

string

PDF
PNG

string

PNG (podporuje se jenom pro sestavy Power BI)
PPTX

string

Microsoft PowerPoint
XLSX

string

Microsoft Excel (podporováno pouze pro stránkované sestavy)
XML

string

XML (podporováno pouze pro stránkované sestavy)

IdentityBlob

Objekt blob pro zadání identity. Podporováno pouze pro datové sady s připojením DirectQuery k Azure SQL

Name Typ Description
value

string

Přístupový token OAuth 2.0 pro Azure SQL

PageBookmark

Záložka, která se má použít 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

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. Povinné, pokud sestava používá datovou sadu Power BI nebo zdroj dat Azure Analysis Services.
parameterValues

ParameterValue[]

Seznam parametrů sestavy

ParameterValue

Kontrakt dat pro parametry stránkované sestavy

Name Typ Description
name

string

Název parametru
value

string

Hodnota parametru

PowerBIReportExportConfiguration

Konfigurace exportu do souboru pro sestavu Power BI

Name Typ Description
datasetToBind

string

ID datové sady, pomocí které chcete sestavu exportovat. Stačí, když exportujete s jinou datovou sadou, než je výchozí datová sada 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, které se mají exportovat, a jejich vlastnosti. Stejná stránka se může zobrazit vícekrát s různými vizuály.
reportLevelFilters

ExportFilter[]

Seznam filtrů na úrovni sestav, které se mají použít. V současné době je podporován pouze jeden filtr.
settings

ExportReportSettings

Nastavení, která se mají použít pro úlohu exportu do souboru