Udostępnij przez

Reports - Export To File

Usługa:
Power BI REST APIs
Wersja interfejsu API:
v1.0

Eksportuje określony raport z Mój obszar roboczy do żądanego formatu pliku .

Interfejs API jest asynchroniczny. Po wywołaniu interfejsu API wyzwala ono zadanie eksportu. Po wyzwoleniu zadania eksportu użyj interfejsu API GetExportToFileStatus, aby śledzić stan zadania. Przeczytaj więcej o całym przepływie: Eksportowanie raportów usługi Power BI i eksportowanie raportów podzielonych na strony

Wymagany zakres

Wszystkie następujące elementy:

  • Report.ReadWrite.All lub Report.Read.All
  • Dataset.ReadWrite.All lub Dataset.Read.All

Ograniczenia

Sprawdź ograniczenia Eksportowanie raportu usługi Power BI do pliku i Eksportowanie raportu podzielonego na strony do pliku. 

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
reportId
 path True

string (uuid)

Identyfikator raportu

Treść żądania

Nazwa Wymagane Typ Opis
format True

FileFormat

Żądany format wyeksportowanego pliku
paginatedReportConfiguration

PaginatedReportExportConfiguration

Konfiguracja używana do eksportowania raportu podzielonego na strony
powerBIReportConfiguration

PowerBIReportExportConfiguration

Konfiguracja używana do eksportowania raportu usługi Power BI

Odpowiedzi

Nazwa Typ Opis
202 Accepted

Export

Zaakceptowano

Definicje

Nazwa Opis
EffectiveIdentity

Definiuje tożsamość i role użytkownika. Aby uzyskać więcej informacji, zobacz Zabezpieczenia na poziomie wiersza w usłudze Power BI Embedded.
Export

Obiekt opisujący szczegóły i bieżący stan zadania eksportu do pliku
ExportFilter

Filtr, który ma zostać zastosowany podczas operacji eksportowania
ExportReportPage

Konfiguracja pojedynczej strony dla żądania eksportu
ExportReportRequest

Żądanie eksportu do pliku
ExportReportSettings

Eksportowanie do ustawień żądania pliku
ExportState

Bieżący stan zadania eksportowania do pliku
FileFormat

Żądany format wyeksportowanego pliku
IdentityBlob

Obiekt blob do określania tożsamości. Obsługiwane tylko w przypadku zestawów danych z połączeniem DirectQuery z usługą Azure SQL
PageBookmark

Zakładka do zastosowania na jednej stronie. Podaj nazwę lub stan, ale nie obie.
PaginatedReportExportConfiguration

Eksportowanie do konfiguracji pliku dla raportu podzielonego na strony
ParameterValue

Kontrakt danych dla parametrów raportu podzielonego na strony
PowerBIReportExportConfiguration

Eksportowanie do konfiguracji pliku dla raportu usługi Power BI

EffectiveIdentity

Objekt

Definiuje tożsamość i role użytkownika. Aby uzyskać więcej informacji, zobacz Zabezpieczenia na poziomie wiersza w usłudze Power BI Embedded.

Nazwa Typ Opis
auditableContext

string

Kontekst z możliwością inspekcji EffectiveIdentity. Jeśli ten parametr jest podany i nie jest pusty, włączy inspekcję elementu EffectiveIdentity, a jego wartość zostanie ustawiona na nazwę użytkownika w rekordzie inspekcji. W przeciwnym razie kontekst EffectiveIdentity zostanie pominięty z rekordu inspekcji GenerateToken.
customData

string

niestandardowych danych używanych do stosowania reguł zabezpieczeń na poziomie wiersza. Obsługiwane tylko w przypadku połączeń na żywo z modelami usług Azure Analysis Services i modelami w chmurze.
datasets

string[]

Tablica zestawów danych, dla których ta tożsamość ma zastosowanie
identityBlob

IdentityBlob

Obiekt blob określający tożsamość . Obsługiwane tylko w przypadku zestawów danych z połączeniem DirectQuery z usługą Azure SQL.
reports

string[]

Tablica raportów, dla których ta tożsamość ma zastosowanie. Obsługiwane tylko w przypadku raportów podzielonych na strony.
roles

string[]

Tablica ról zabezpieczeń na poziomie wiersza w tokenie, który stosuje reguły zabezpieczeń na poziomie wiersza. Tożsamość może zawierać maksymalnie 50 ról. Rola może zawierać dowolny znak z wyjątkiem ,, a jego długość nie może przekraczać 50 znaków.
username

string

Obowiązująca nazwa użytkownika w tokenie, który stosuje reguły zabezpieczeń na poziomie wiersza. W przypadku modelu lokalnego nazwa użytkownika może zawierać alfanumeryczne lub dowolne z następujących znaków ., -, _, !, #, ^, ~, \\, @. W przypadku modeli w chmurze nazwa użytkownika może zawierać dowolny znak ASCII. W przypadku obu modeli długość nazwy użytkownika nie może przekraczać 256 znaków, a nazwa użytkownika nie powinna zawierać spacji.

Export

Objekt

Obiekt opisujący szczegóły i bieżący stan zadania eksportu do pliku

Nazwa Typ Opis
createdDateTime

string (date-time)

Data i godzina rozpoczęcia eksportu do zadania pliku
expirationTime

string (date-time)

Data i godzina wygaśnięcia adresu URL pobierania
id

string

Identyfikator zadania eksportowania do pliku
lastActionDateTime

string (date-time)

Data i godzina ostatniej zmiany zadania eksportowania do pliku
percentComplete

integer (int32)

minimum: 0
maximum: 100

Postęp zadania jako wartość procentowa
reportId

string (uuid)

Identyfikator wyeksportowanego raportu
reportName

string

Nazwa wyeksportowanego raportu
resourceFileExtension

string

Rozszerzenie wyeksportowanego pliku
resourceLocation

string

Adres URL pobierania wyeksportowanego pliku
status

ExportState

Bieżący stan zadania eksportowania do pliku

ExportFilter

Objekt

Filtr, który ma zostać zastosowany podczas operacji eksportowania

Nazwa Typ Opis
filter

string

Filtr do zastosowania. Aby uzyskać informacje o składni filtru, zobacz Filtruj raport.

ExportReportPage

Objekt

Konfiguracja pojedynczej strony dla żądania eksportu

Nazwa Typ Opis
bookmark

PageBookmark

Zakładka do zastosowania na stronie
pageName

string

Nazwa strony
visualName

string

Nazwa wizualizacji do wyeksportowania. Określ nazwę, jeśli zostanie wyeksportowana tylko jedna wizualizacja z tej strony.

ExportReportRequest

Objekt

Żądanie eksportu do pliku

Nazwa Typ Opis
format

FileFormat

Żądany format wyeksportowanego pliku
paginatedReportConfiguration

PaginatedReportExportConfiguration

Konfiguracja używana do eksportowania raportu podzielonego na strony
powerBIReportConfiguration

PowerBIReportExportConfiguration

Konfiguracja używana do eksportowania raportu usługi Power BI

ExportReportSettings

Objekt

Eksportowanie do ustawień żądania pliku

Nazwa Typ Opis
includeHiddenPages

boolean

Określa, czy podczas eksportowania całego raportu mają być uwzględniane ukryte strony. Jeśli nie zostanie podana, domyślne zachowanie polega na wykluczeniu ukrytych stron. Ta właściwość zostanie zignorowana po wyeksportowaniu określonych stron.
locale

string

Ustawienia regionalne do zastosowania

ExportState

Wyliczanie

Bieżący stan zadania eksportowania do pliku

Wartość Opis
Undefined

Stan zadania eksportowania do pliku jest niezdefiniowany
NotStarted

Zadanie eksportowania do pliku nie zostało uruchomione
Running

Zadanie eksportowania do pliku jest uruchomione
Succeeded

Pomyślnie zakończono zadanie eksportowania do pliku
Failed

Zadanie eksportowania do pliku nie powiodło się

FileFormat

Wyliczanie

Żądany format wyeksportowanego pliku

Wartość Opis
PPTX

Microsoft PowerPoint
PDF

PDF
PNG

PNG (obsługiwane tylko w przypadku raportów usługi Power BI)
IMAGE

Formaty obrazów BMP, EMF, GIF, JPEG, PNG lub TIFF (obsługiwane tylko w przypadku raportów podzielonych na strony)
XLSX

Microsoft Excel (obsługiwane tylko w przypadku raportów podzielonych na strony)
DOCX

Microsoft Word (obsługiwane tylko w przypadku raportów podzielonych na strony)
CSV

CSV (obsługiwane tylko w przypadku raportów podzielonych na strony)
XML

XML (obsługiwane tylko w przypadku raportów podzielonych na strony)
MHTML

MHTML (obsługiwane tylko w przypadku raportów podzielonych na strony)
ACCESSIBLEPDF

Dostępny plik PDF (obsługiwany tylko w przypadku raportów podzielonych na strony)

IdentityBlob

Objekt

Obiekt blob do określania tożsamości. Obsługiwane tylko w przypadku zestawów danych z połączeniem DirectQuery z usługą Azure SQL

Nazwa Typ Opis
value

string

Token dostępu OAuth 2.0 dla usługi Azure SQL

PageBookmark

Objekt

Zakładka do zastosowania na jednej stronie. Podaj nazwę lub stan, ale nie obie.

Nazwa Typ Opis
name

string

Nazwa zakładki
state

string

Stan zakładki

PaginatedReportExportConfiguration

Objekt

Eksportowanie do konfiguracji pliku dla raportu podzielonego na strony

Nazwa Typ Opis
formatSettings

object

Słownik ustawień formatu. Klucze to nazwy właściwości informacji o urządzeniu dla żądanego formatu pliku.
identities

EffectiveIdentity[]

Pojedyncza tożsamość do użycia podczas eksportowania raportu. Wymagane, gdy raport używa zestawu danych usługi Power BI lub źródła danych usług Azure Analysis Services.
locale

string

Ustawienia regionalne do zastosowania
parameterValues

ParameterValue[]

Lista parametrów raportu

ParameterValue

Objekt

Kontrakt danych dla parametrów raportu podzielonego na strony

Nazwa Typ Opis
name

string

Nazwa parametru
value

string

Wartość parametru

PowerBIReportExportConfiguration

Objekt

Eksportowanie do konfiguracji pliku dla raportu usługi Power BI

Nazwa Typ Opis
datasetToBind

string

Identyfikator zestawu danych do wyeksportowania raportu za pomocą polecenia. Wymagane tylko w przypadku eksportowania z zestawem danych innym niż domyślny zestaw danych raportu.
defaultBookmark

PageBookmark

Domyślna zakładka do zastosowania na wszystkich stronach, które nie mają określonej zakładki
identities

EffectiveIdentity[]

Lista tożsamości do użycia dla reguł zabezpieczeń na poziomie wiersza
pages

ExportReportPage[]

Lista stron do wyeksportowania i ich właściwości. Ta sama strona może pojawić się więcej niż raz z różnymi wizualizacjami.
reportLevelFilters

ExportFilter[]

Lista filtrów na poziomie raportu do zastosowania. Obecnie obsługiwany jest tylko jeden filtr.
settings

ExportReportSettings

Ustawienia, które mają być stosowane do zadania eksportowania do pliku