共用方式為

Reports - Export To File

  • 參考
服務:
Power BI REST APIs
API 版本:
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

Object

定義使用者身分識別和角色。 如需詳細資訊，請參閱使用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

Object

物件，描述導出至檔案作業的詳細數據和目前狀態

名稱 類型 Description
createdDateTime

string (date-time)

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

string (date-time)

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

string

匯出至檔案作業標識碼
lastActionDateTime

string (date-time)

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

integer (int32)

minimum: 0
maximum: 100

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

string (uuid)

匯出報表的標識碼
reportName

string

匯出報表的名稱
resourceFileExtension

string

匯出檔案的擴展名
resourceLocation

string

導出檔案的擷取 URL
status

ExportState

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

ExportFilter

Object

匯出作業期間要套用的篩選條件

名稱 類型 Description
filter

string

要套用的篩選。 如需篩選語法的相關信息，請參閱 篩選報表。

ExportReportPage

Object

匯出要求的單一頁面組態

名稱 類型 Description
bookmark

PageBookmark

要套用在頁面上的書籤
pageName

string

頁面名稱
visualName

string

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

ExportReportRequest

Object

匯出至檔案要求

名稱 類型 Description
format

FileFormat

匯出檔案的要求格式
paginatedReportConfiguration

PaginatedReportExportConfiguration

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

PowerBIReportExportConfiguration

用來導出Power BI報表的組態

ExportReportSettings

Object

匯出至檔案要求設定

名稱 類型 Description
includeHiddenPages

boolean

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

string

要套用的地區設定

ExportState

列舉型別

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

值 Description
Failed

匯出至檔案作業失敗
NotStarted

匯出至檔案作業未啟動
Running

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

匯出至檔案作業已順利完成
Undefined

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

FileFormat

列舉型別

匯出檔案的要求格式

值 Description
ACCESSIBLEPDF

無障礙 PDF （僅支援編頁報表）
CSV

CSV （僅支援編頁報表）
DOCX

Microsoft Word （僅支持編頁報表）
IMAGE

BMP、EMF、GIF、JPEG、PNG 或 TIFF 影像 格式（僅支援編頁報表）
MHTML

MHTML （僅支援編頁報表）
PDF

PDF
PNG

PNG （僅支援 Power BI 報表）
PPTX

Microsoft PowerPoint
XLSX

Microsoft Excel （僅支持編頁報表）
XML

XML （只支援編頁報表 ）

IdentityBlob

Object

指定身分識別的 Blob。 僅支援具有 Azure SQL DirectQuery 連線的數據集

名稱 類型 Description
value

string

Azure SQL 的 OAuth 2.0 存取令牌

PageBookmark

Object

要套用至單一頁面上的書籤。 提供名稱或狀態，但不能同時提供兩者。

名稱 類型 Description
name

string

書簽名稱
state

string

書籤狀態

PaginatedReportExportConfiguration

Object

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

名稱 類型 Description
formatSettings

object

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

EffectiveIdentity[]

匯出報表時要使用的單一身分識別。 當報表使用 Power BI 數據集或 Azure Analysis Services 數據源時需要。
locale

string

要套用的地區設定
parameterValues

ParameterValue[]

報表參數清單

ParameterValue

Object

編頁報表參數的數據合約

名稱 類型 Description
name

string

參數名稱
value

string

參數值

PowerBIReportExportConfiguration

Object

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

名稱 類型 Description
datasetToBind

string

用來匯出報表的數據集標識碼。 只有在使用報表預設數據集以外的數據集進行導出時才需要。
defaultBookmark

PageBookmark

在沒有特定書籤的所有頁面上套用的預設書籤
identities

EffectiveIdentity[]

要用於數據列層級安全性規則的身分識別清單
pages

ExportReportPage[]

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

ExportFilter[]

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

ExportReportSettings

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