Reports - Export To File

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

將指定的報表從 [我的工作區 ] 匯出至要求的 檔案格式。

該 API 是非同步的。 呼叫 API 時，它會觸發匯出作業。 觸發匯出作業之後，請使用 GetExportToFileStatus API 來追蹤作業狀態。 深入瞭解整個流程： 匯出 Power BI 報表 和 匯出編頁報表

必要範圍

下列所有專案：

  • Report.ReadWrite.All 或 Report.Read.All
  • Dataset.ReadWrite.All 或 Dataset.Read.All

限制

檢查 將 Power BI 報表匯出為檔案 的限制，並將 編頁報表匯出至檔案。 

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

URI 參數

名稱 位於 必要 類型 Description
reportId
 path True

string

uuid

報表識別碼

要求本文

名稱 必要 類型 Description
format True

FileFormat

匯出檔案的要求格式
paginatedReportConfiguration

PaginatedReportExportConfiguration

用來匯出編頁報表的組態
powerBIReportConfiguration

PowerBIReportExportConfiguration

用來匯出 Power BI 報表的組態

回應

名稱 類型 Description
202 Accepted

Export

已接受

定義

名稱 Description
EffectiveIdentity

定義使用者身分識別和角色。 如需詳細資訊，請參閱資料列層級安全性與Power BI Embedded。
Export

物件，描述匯出至檔案作業的詳細資料和目前狀態
ExportFilter

匯出作業期間要套用的篩選準則
ExportReportPage

匯出要求的單頁組態
ExportReportRequest

匯出至檔案要求
ExportReportSettings

匯出至檔案要求設定
ExportState

匯出至檔案作業的目前狀態
FileFormat

匯出檔案的要求格式
IdentityBlob

用於指定身分識別的 Blob。 僅支援具有與 Azure SQL 之 DirectQuery 連線的資料集
PageBookmark

單一頁面上要套用的書簽。 提供名稱或狀態，但不提供兩者。
PaginatedReportExportConfiguration

匯出至編頁報表的檔案組態
ParameterValue

編頁報表參數的資料合約
PowerBIReportExportConfiguration

Power BI 報表的匯出至檔案組態

EffectiveIdentity

定義使用者身分識別和角色。 如需詳細資訊，請參閱資料列層級安全性與Power BI Embedded。

名稱 類型 Description
auditableContext

string

EffectiveIdentity 可稽核的內容。 如果提供此參數且不是空的，則會啟用 EffectiveIdentity 的稽核，並將其值設定為稽核記錄中的使用者名稱。 否則，會從 GenerateToken 稽核記錄中省略 EffectiveIdentity 內容。
customData

string

用來套用資料列層級安全性規則的自訂資料。 僅支援與Azure Analysis Services模型和雲端模型的即時連線。
datasets

string[]

套用此身分識別的資料集陣列
identityBlob

IdentityBlob

指定 身分識別的 Blob。 僅支援具有與 Azure SQL 之 DirectQuery 連線的資料集。
reports

string[]

套用此身分識別的報表陣列。 僅支援編頁報表。
roles

string[]

套用 RLS 規則的權杖內，資料列層級安全性 (RLS) 角色的陣列。 身分識別最多可以包含 50 個角色。 角色可以包含除了 以外的 , 任何字元，而且其長度不能超過 50 個字元。
username

string

套用資料列層級安全性規則之權杖內的有效使用者名稱。 針對內部部署模型，使用者名稱可以包含英數位元或下列任何字元 . 、 - 、 ^!_# 、 ~ 、、 。 \\@ 針對雲端模型，使用者名稱可以包含任何 ASCII 字元。 針對任一模型，使用者名稱長度不能超過 256 個字元，而且使用者名稱不應包含空格。

Export

物件，描述匯出至檔案作業的詳細資料和目前狀態

名稱 類型 Description
ResourceFileExtension

string

匯出檔案的副檔名
createdDateTime

string

匯出至檔案作業的開始日期和時間
expirationTime

string

擷取 URL 的到期日期和時間
id

string

匯出至檔案作業識別碼
lastActionDateTime

string

上次匯出至檔案作業之變更的日期和時間
percentComplete

integer

以百分比表示的作業進度
reportId

string

匯出報表的識別碼
reportName

string

匯出報表的名稱
resourceLocation

string

匯出檔案的擷取 URL
status

ExportState

匯出至檔案作業的目前狀態

ExportFilter

匯出作業期間要套用的篩選準則

名稱 類型 Description
filter

string

要套用的篩選條件。 如需篩選語法的相關資訊，請參閱 篩選報表。

ExportReportPage

匯出要求的單頁組態

名稱 類型 Description
bookmark

PageBookmark

要套用在頁面上的書簽
pageName

string

頁面名稱
visualName

string

要匯出的視覺效果名稱。 指定名稱，以防匯出此頁面中的單一視覺效果。

ExportReportRequest

匯出至檔案要求

名稱 類型 Description
format

FileFormat

匯出檔案的要求格式
paginatedReportConfiguration

PaginatedReportExportConfiguration

用來匯出編頁報表的組態
powerBIReportConfiguration

PowerBIReportExportConfiguration

用來匯出 Power BI 報表的組態

ExportReportSettings

匯出至檔案要求設定

名稱 類型 Description
includeHiddenPages

boolean

匯出整個報表時是否要包含隱藏的頁面。 如果未提供，預設行為是排除隱藏的頁面。 匯出特定頁面時，將會忽略這個屬性。
locale

string

要套用的地區設定

ExportState

匯出至檔案作業的目前狀態

名稱 類型 Description
Failed

string

匯出至檔案作業失敗
NotStarted

string

匯出至檔案作業未啟動
Running

string

匯出至檔案作業正在執行中
Succeeded

string

已成功匯出至檔案作業
Undefined

string

匯出至檔案作業的狀態為未定義

FileFormat

匯出檔案的要求格式

名稱 類型 Description
ACCESSIBLEPDF

string

只有編頁報表支援可存取的 PDF ()

CSV

string

CSV (僅支援編頁報表)

DOCX

string

Microsoft Word (僅支援編頁報表)

IMAGE

string

BMP、EMF、GIF、JPEG、PNG 或 TIFF 影像 格式 (僅支援編頁報表)

MHTML

string

MHTML (僅支援編頁報表)

PDF

string

PDF
PNG

string

只有 Power BI 報表) 才支援 PNG (
PPTX

string

Microsoft PowerPoint
XLSX

string

Microsoft Excel (僅支援編頁報表)

XML

string

XML (僅支援編頁報表)

IdentityBlob

用於指定身分識別的 Blob。 僅支援具有與 Azure SQL 之 DirectQuery 連線的資料集

名稱 類型 Description
value

string

適用于 Azure SQL 的 OAuth 2.0 存取權杖

PageBookmark

單一頁面上要套用的書簽。 提供名稱或狀態，但不提供兩者。

名稱 類型 Description
name

string

書簽名稱
state

string

書簽狀態

PaginatedReportExportConfiguration

匯出至編頁報表的檔案組態

名稱 類型 Description
formatSettings

object

格式設定的字典。 索引鍵是所要求檔案格式的裝置資訊屬性名稱。
identities

EffectiveIdentity[]

匯出報表時要使用的單一身分識別。 報表使用 Power BI 資料集或Azure Analysis Services資料來源時為必要專案。
parameterValues

ParameterValue[]

報表參數的清單

ParameterValue

編頁報表參數的資料合約

名稱 類型 Description
name

string

參數名稱
value

string

參數值

PowerBIReportExportConfiguration

Power BI 報表的匯出至檔案組態

名稱 類型 Description
datasetToBind

string

用來匯出報表的資料集識別碼。 只有在使用報表預設資料集以外的資料集進行匯出時才需要。
defaultBookmark

PageBookmark

所有沒有特定書簽的頁面上要套用的預設書簽
identities

EffectiveIdentity[]

用於資料列層級安全性規則的身分識別清單
pages

ExportReportPage[]

要匯出的頁面清單及其屬性。 同一個頁面可能會以不同的視覺效果顯示一次以上。
reportLevelFilters

ExportFilter[]

要套用的報表層級篩選清單。 目前僅支援一個篩選。
settings

ExportReportSettings

要套用至檔案作業之匯出的設定