Bagikan melalui

Reports - Export To File In Group

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

Mengekspor laporan yang ditentukan dari ruang kerja yang ditentukan ke format file yang diminta.

API bersifat asinkron. Ketika API dipanggil, API memicu pekerjaan ekspor. Setelah memicu pekerjaan ekspor, gunakan GetExportToFileStatus API untuk melacak status pekerjaan. Baca selengkapnya tentang seluruh alur: Mengekspor laporan Power BI dan Mengekspor laporan Paginated

Izin

Panggilan API ini dapat dipanggil oleh profil perwakilan layanan. Untuk informasi selengkapnya lihat: Profil perwakilan layanan di Power BI Embedded.

Cakupan yang Diperlukan

Semua hal berikut:

  • Report.ReadWrite.All atau Report.Read.All
  • Dataset.ReadWrite.All atau Dataset.Read.All

Batasan

Periksa batasan dalam Ekspor laporan Power BI ke file dan Ekspor laporan paginasi ke file. 

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
groupId
 path True

string

uuid

ID ruang kerja
reportId
 path True

string

uuid

ID laporan

Isi Permintaan

Nama Diperlukan Jenis Deskripsi
format True

FileFormat

Format yang diminta untuk file yang diekspor
paginatedReportConfiguration

PaginatedReportExportConfiguration

Konfigurasi yang digunakan untuk mengekspor laporan yang dipaginasi
powerBIReportConfiguration

PowerBIReportExportConfiguration

Konfigurasi yang digunakan untuk mengekspor laporan Power BI

Respons

Nama Jenis Deskripsi
202 Accepted

Export

Diterima

Definisi

Nama Deskripsi
EffectiveIdentity

Menentukan identitas dan peran pengguna. Untuk informasi selengkapnya, lihat Keamanan tingkat baris dengan Power BI Embedded.
Export

Objek yang menjelaskan detail dan status ekspor saat ini ke pekerjaan file
ExportFilter

Filter yang akan diterapkan selama operasi ekspor
ExportReportPage

Konfigurasi satu halaman untuk permintaan ekspor
ExportReportRequest

Ekspor ke permintaan file
ExportReportSettings

Mengekspor ke pengaturan permintaan file
ExportState

Status ekspor ke pekerjaan file saat ini
FileFormat

Format yang diminta untuk file yang diekspor
IdentityBlob

Blob untuk menentukan identitas. Hanya didukung untuk himpunan data dengan koneksi DirectQuery ke Azure SQL
PageBookmark

Bookmark untuk diterapkan pada satu halaman. Berikan nama atau status, tetapi tidak keduanya.
PaginatedReportExportConfiguration

Ekspor ke konfigurasi file untuk laporan paginasi
ParameterValue

Kontrak data untuk parameter laporan yang dipaginasi
PowerBIReportExportConfiguration

Ekspor ke konfigurasi file untuk laporan Power BI

EffectiveIdentity

Menentukan identitas dan peran pengguna. Untuk informasi selengkapnya, lihat Keamanan tingkat baris dengan Power BI Embedded.

Nama Jenis Deskripsi
auditableContext

string

Konteks yang dapat diaudit EffectiveIdentity. Jika parameter ini disediakan dan tidak kosong, parameter ini akan memungkinkan audit EffectiveIdentity dan nilainya akan diatur ke nama pengguna dalam catatan audit. Jika tidak, konteks EffectiveIdentity akan dihilangkan dari catatan audit GenerateToken.
customData

string

Data kustom yang digunakan untuk menerapkan aturan keamanan tingkat baris. Didukung untuk koneksi langsung ke model Azure Analysis Services dan model cloud saja.
datasets

string[]

Array himpunan data tempat identitas ini berlaku
identityBlob

IdentityBlob

Blob yang menentukan identitas. Hanya didukung untuk himpunan data dengan koneksi DirectQuery ke Azure SQL.
reports

string[]

Array laporan tempat identitas ini berlaku. Hanya didukung untuk laporan yang dipaginasi.
roles

string[]

Array peran keamanan tingkat baris (RLS) dalam token yang menerapkan aturan RLS. Identitas dapat berisi hingga 50 peran. Peran dapat berisi karakter apa pun kecuali ,, dan panjangnya tidak boleh melebihi 50 karakter.
username

string

Nama pengguna yang efektif dalam token yang menerapkan aturan keamanan tingkat baris. Untuk model lokal, nama pengguna dapat berisi alfanumerik atau salah satu karakter .berikut , , , -, _#!, ^, ~, , . @\\ Untuk model cloud, nama pengguna dapat berisi karakter ASCII apa pun. Untuk salah satu model, panjang nama pengguna tidak boleh melebihi 256 karakter, dan nama pengguna tidak boleh berisi spasi.

Export

Objek yang menjelaskan detail dan status ekspor saat ini ke pekerjaan file

Nama Jenis Deskripsi
ResourceFileExtension

string

Ekstensi file yang diekspor
createdDateTime

string

Tanggal dan waktu mulai ekspor ke pekerjaan file
expirationTime

string

Tanggal kedaluwarsa dan waktu URL pengambilan
id

string

Ekspor ke ID pekerjaan file
lastActionDateTime

string

Tanggal dan waktu perubahan terakhir pada pekerjaan ekspor ke file
percentComplete

integer

Kemajuan pekerjaan sebagai persentase
reportId

string

ID laporan yang diekspor
reportName

string

Nama laporan yang diekspor
resourceLocation

string

URL pengambilan untuk file yang diekspor
status

ExportState

Status ekspor ke pekerjaan file saat ini

ExportFilter

Filter yang akan diterapkan selama operasi ekspor

Nama Jenis Deskripsi
filter

string

Filter yang akan diterapkan. Untuk informasi tentang sintaks filter, lihat Memfilter laporan.

ExportReportPage

Konfigurasi satu halaman untuk permintaan ekspor

Nama Jenis Deskripsi
bookmark

PageBookmark

Bookmark yang akan diterapkan pada halaman
pageName

string

Nama halaman
visualName

string

Nama visual yang akan diekspor. Tentukan nama, jika hanya satu visual dari halaman ini yang diekspor.

ExportReportRequest

Ekspor ke permintaan file

Nama Jenis Deskripsi
format

FileFormat

Format yang diminta untuk file yang diekspor
paginatedReportConfiguration

PaginatedReportExportConfiguration

Konfigurasi yang digunakan untuk mengekspor laporan yang dipaginasi
powerBIReportConfiguration

PowerBIReportExportConfiguration

Konfigurasi yang digunakan untuk mengekspor laporan Power BI

ExportReportSettings

Mengekspor ke pengaturan permintaan file

Nama Jenis Deskripsi
includeHiddenPages

boolean

Apakah akan menyertakan halaman tersembunyi saat mengekspor seluruh laporan. Jika tidak disediakan, perilaku defaultnya adalah mengecualikan halaman tersembunyi. Properti ini akan diabaikan ketika halaman tertentu diekspor.
locale

string

Lokal yang akan diterapkan

ExportState

Status ekspor ke pekerjaan file saat ini

Nama Jenis Deskripsi
Failed

string

Tugas ekspor ke file gagal
NotStarted

string

Ekspor ke pekerjaan file tidak dimulai
Running

string

Tugas ekspor ke file sedang berjalan
Succeeded

string

Ekspor ke pekerjaan file berhasil diselesaikan
Undefined

string

Status ekspor ke pekerjaan file tidak terdefinisi

FileFormat

Format yang diminta untuk file yang diekspor

Nama Jenis Deskripsi
ACCESSIBLEPDF

string

PDF yang dapat diakses (hanya didukung untuk laporan yang dipaginasi)
CSV

string

CSV (hanya didukung untuk laporan paginasi)
DOCX

string

Microsoft Word (hanya didukung untuk laporan paginasi)
IMAGE

string

Format gambar BMP, EMF, GIF, JPEG, PNG, atau TIFF (hanya didukung untuk laporan paginasi)
MHTML

string

MHTML (hanya didukung untuk laporan paginasi)
PDF

string

PDF
PNG

string

PNG (hanya didukung untuk laporan Power BI)
PPTX

string

Microsoft PowerPoint
XLSX

string

Microsoft Excel (hanya didukung untuk laporan yang dipaginasi)
XML

string

XML (hanya didukung untuk laporan yang dipaginasi)

IdentityBlob

Blob untuk menentukan identitas. Hanya didukung untuk himpunan data dengan koneksi DirectQuery ke Azure SQL

Nama Jenis Deskripsi
value

string

Token akses OAuth 2.0 untuk Azure SQL

PageBookmark

Bookmark untuk diterapkan pada satu halaman. Berikan nama atau status, tetapi tidak keduanya.

Nama Jenis Deskripsi
name

string

Nama bookmark
state

string

Status bookmark

PaginatedReportExportConfiguration

Ekspor ke konfigurasi file untuk laporan paginasi

Nama Jenis Deskripsi
formatSettings

object

Kamus pengaturan format. Kuncinya adalah nama properti informasi perangkat untuk format file yang diminta.
identities

EffectiveIdentity[]

Identitas tunggal yang digunakan saat mengekspor laporan. Diperlukan saat laporan menggunakan himpunan data Power BI atau sumber data Azure Analysis Services.
parameterValues

ParameterValue[]

Daftar parameter laporan

ParameterValue

Kontrak data untuk parameter laporan yang dipaginasi

Nama Jenis Deskripsi
name

string

Nama parameter
value

string

Nilai parameter

PowerBIReportExportConfiguration

Ekspor ke konfigurasi file untuk laporan Power BI

Nama Jenis Deskripsi
datasetToBind

string

ID himpunan data untuk mengekspor laporan. Hanya diperlukan jika mengekspor dengan himpunan data selain himpunan data default laporan.
defaultBookmark

PageBookmark

Bookmark default untuk diterapkan pada semua halaman yang tidak memiliki bookmark tertentu
identities

EffectiveIdentity[]

Daftar identitas yang digunakan untuk aturan keamanan tingkat baris
pages

ExportReportPage[]

Daftar halaman yang akan diekspor dan propertinya. Halaman yang sama mungkin muncul lebih dari sekali dengan visual yang berbeda.
reportLevelFilters

ExportFilter[]

Daftar filter tingkat laporan yang akan diterapkan. Saat ini, hanya satu filter yang didukung.
settings

ExportReportSettings

Pengaturan yang akan diterapkan untuk tugas ekspor ke file