Udostępnij za pośrednictwem


Reports - Export To File

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

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

Zakres wymagany

Wszystkie następujące elementy:

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

Ograniczenia

Sprawdź ograniczenia w artykule 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ść użytkownika i role. Aby uzyskać więcej informacji, zobacz Zabezpieczenia na poziomie wiersza z Power BI Embedded.

Export

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

ExportFilter

Filtr do zastosowania 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 określający tożsamość. Obsługiwane tylko w przypadku zestawów danych z połączeniem DirectQuery z Azure SQL

PageBookmark

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

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

Definiuje tożsamość użytkownika i role. Aby uzyskać więcej informacji, zobacz Zabezpieczenia na poziomie wiersza z 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ę wartości EffectiveIdentity, a jej wartość zostanie ustawiona na nazwę użytkownika w rekordzie inspekcji. W przeciwnym razie kontekst EffectiveIdentity zostanie pominięty z rekordu inspekcji GenerateToken.

customData

string

Niestandardowe dane używane do stosowania reguł zabezpieczeń na poziomie wiersza. Obsługiwane w przypadku połączeń na żywo tylko z modelami 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 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 (RLS) 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 ,znaku , 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

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

Nazwa Typ Opis
ResourceFileExtension

string

Rozszerzenie wyeksportowanego pliku

createdDateTime

string

Data i godzina rozpoczęcia eksportu do zadania pliku

expirationTime

string

Data i godzina wygaśnięcia adresu URL pobierania

id

string

Identyfikator zadania eksportowania do pliku

lastActionDateTime

string

Data i godzina ostatniej zmiany zadania eksportowania do pliku

percentComplete

integer

Postęp zadania jako procent

reportId

string

Identyfikator wyeksportowanego raportu

reportName

string

Nazwa wyeksportowanego raportu

resourceLocation

string

Adres URL pobierania wyeksportowanego pliku

status

ExportState

Bieżący stan zadania eksportowania do pliku

ExportFilter

Filtr do zastosowania podczas operacji eksportowania

Nazwa Typ Opis
filter

string

Filtr do zastosowania. Aby uzyskać informacje o składni filtru, zobacz Filtrowanie raportu.

ExportReportPage

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

Żą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

Eksportowanie do ustawień żądania pliku

Nazwa Typ Opis
includeHiddenPages

boolean

Czy należy dołączać ukryte strony podczas eksportowania całego raportu. Jeśli nie podano, domyślnym zachowaniem jest wykluczenie ukrytych stron. Ta właściwość zostanie zignorowana podczas eksportowania określonych stron.

locale

string

Ustawienia regionalne do zastosowania

ExportState

Bieżący stan zadania eksportowania do pliku

Nazwa Typ Opis
Failed

string

Zadanie eksportowania do pliku nie powiodło się

NotStarted

string

Zadanie eksportowania do pliku nie zostało uruchomione

Running

string

Zadanie eksportowania do pliku jest uruchomione

Succeeded

string

Zadanie eksportowania do pliku zostało zakończone pomyślnie

Undefined

string

Stan zadania eksportowania do pliku jest niezdefiniowany

FileFormat

Żądany format wyeksportowanego pliku

Nazwa Typ Opis
ACCESSIBLEPDF

string

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

CSV

string

PLIK CSV (obsługiwany tylko w przypadku raportów podzielonych na strony)

DOCX

string

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

IMAGE

string

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

MHTML

string

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

PDF

string

PDF

PNG

string

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

PPTX

string

Microsoft PowerPoint

XLSX

string

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

XML

string

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

IdentityBlob

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

Nazwa Typ Opis
value

string

Token dostępu OAuth 2.0 dla Azure SQL

PageBookmark

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

Nazwa Typ Opis
name

string

Nazwa zakładki

state

string

Stan zakładki

PaginatedReportExportConfiguration

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 Azure Analysis Services.

parameterValues

ParameterValue[]

Lista parametrów raportu

ParameterValue

Kontrakt danych dla parametrów raportu podzielonego na strony

Nazwa Typ Opis
name

string

Nazwa parametru

value

string

Wartość parametru

PowerBIReportExportConfiguration

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