Reports - Export To File
指定したレポートを [マイ ワークスペース] から要求された ファイル形式にエクスポートします。
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}/ExportToURI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
report
|
path | True |
string uuid |
レポート ID |
要求本文
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| format | True |
エクスポートされたファイルの要求された形式 |
|
| paginatedReportConfiguration |
ページ分割されたレポートのエクスポートに使用される構成 |
||
| powerBIReportConfiguration |
Power BI レポートのエクスポートに使用される構成 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 202 Accepted |
同意 |
定義
| 名前 | 説明 |
|---|---|
|
Effective |
ユーザー ID とロールを定義します。 詳細については、「Power BI Embeddedを使用した行レベルのセキュリティ」を参照してください。 |
| Export |
ファイル ジョブへのエクスポートの詳細と現在の状態を記述する オブジェクト |
|
Export |
エクスポート操作中に適用されるフィルター |
|
Export |
エクスポート要求の単一ページ構成 |
|
Export |
ファイルへのエクスポート要求 |
|
Export |
ファイル要求設定へのエクスポート |
|
Export |
ファイル ジョブへのエクスポートの現在の状態 |
|
File |
エクスポートされたファイルの要求された形式 |
|
Identity |
ID を指定するための BLOB。 Azure SQL への DirectQuery 接続を持つデータセットでのみサポートされます |
|
Page |
1 つのページに適用するブックマーク。 名前または状態を指定しますが、両方は指定しないでください。 |
|
Paginated |
ページ分割されたレポートのファイルへのエクスポート構成 |
|
Parameter |
ページ分割されたレポート パラメーターのデータ コントラクト |
|
Power |
Power BI レポートのファイルへのエクスポート構成 |
EffectiveIdentity
ユーザー ID とロールを定義します。 詳細については、「Power BI Embeddedを使用した行レベルのセキュリティ」を参照してください。
| 名前 | 型 | 説明 |
|---|---|---|
| auditableContext |
string |
EffectiveIdentity 監査可能なコンテキスト。 このパラメーターが指定され、空でない場合は、EffectiveIdentity の監査が有効になり、その値は監査レコードのユーザー名に設定されます。 それ以外の場合、GenerateToken 監査レコードから EffectiveIdentity コンテキストが省略されます。 |
| customData |
string |
行レベルのセキュリティ規則を適用するために使用されるカスタム データ。 Azure Analysis Services モデルとクラウド モデルへのライブ接続でのみサポートされます。 |
| datasets |
string[] |
この ID が適用されるデータセットの配列 |
| identityBlob |
ID を指定する BLOB。 Azure SQLへの DirectQuery 接続を持つデータセットでのみサポートされます。 |
|
| reports |
string[] |
この ID が適用されるレポートの配列。 ページ分割されたレポートでのみサポートされます。 |
| roles |
string[] |
RLS ルールを適用するトークン内の行レベル セキュリティ (RLS) ロールの配列。 ID には、最大 50 個のロールを含めることができます。 ロールには を除く |
| username |
string |
行レベルのセキュリティ規則を適用するトークン内の有効なユーザー名。 オンプレミス モデルの場合、ユーザー名には英数字、または次の文字 |
Export
ファイル ジョブへのエクスポートの詳細と現在の状態を記述する オブジェクト
| 名前 | 型 | 説明 |
|---|---|---|
| ResourceFileExtension |
string |
エクスポートされたファイルの拡張子 |
| createdDateTime |
string |
ファイル ジョブへのエクスポートの開始日時 |
| expirationTime |
string |
取得 URL の有効期限の日付と時刻 |
| id |
string |
ファイル へのエクスポート ジョブ ID |
| lastActionDateTime |
string |
ファイルへのエクスポート ジョブに対する最後の変更の日時 |
| percentComplete |
integer |
ジョブの進行状況 (パーセンテージ) |
| reportId |
string |
エクスポートされたレポートの ID |
| reportName |
string |
エクスポートされたレポートの名前 |
| resourceLocation |
string |
エクスポートされたファイルの取得 URL |
| status |
ファイル ジョブへのエクスポートの現在の状態 |
ExportFilter
エクスポート操作中に適用されるフィルター
| 名前 | 型 | 説明 |
|---|---|---|
| filter |
string |
適用するフィルター。 フィルター構文の詳細については、「レポートの フィルター処理」を参照してください。 |
ExportReportPage
エクスポート要求の単一ページ構成
| 名前 | 型 | 説明 |
|---|---|---|
| bookmark |
ページに適用するブックマーク |
|
| pageName |
string |
ページ名 |
| visualName |
string |
エクスポートするビジュアルの名前。 このページから 1 つのビジュアルのみがエクスポートされる場合は、名前を指定します。 |
ExportReportRequest
ファイルへのエクスポート要求
| 名前 | 型 | 説明 |
|---|---|---|
| format |
エクスポートされたファイルの要求された形式 |
|
| paginatedReportConfiguration |
ページ分割されたレポートのエクスポートに使用される構成 |
|
| powerBIReportConfiguration |
Power BI レポートのエクスポートに使用される構成 |
ExportReportSettings
ファイル要求設定へのエクスポート
| 名前 | 型 | 説明 |
|---|---|---|
| includeHiddenPages |
boolean |
レポート全体をエクスポートするときに非表示ページを含めるかどうか。 指定しない場合、既定の動作は非表示ページを除外することです。 このプロパティは、特定のページがエクスポートされるときに無視されます。 |
| locale |
string |
適用するロケール |
ExportState
ファイル ジョブへのエクスポートの現在の状態
| 名前 | 型 | 説明 |
|---|---|---|
| Failed |
string |
ファイルへのエクスポート ジョブが失敗しました |
| NotStarted |
string |
ファイルへのエクスポート ジョブが開始されませんでした |
| Running |
string |
ファイルへのエクスポート ジョブが実行されている |
| Succeeded |
string |
ファイルへのエクスポート ジョブが正常に完了しました |
| Undefined |
string |
ファイル へのエクスポート ジョブの状態が未定義です |
FileFormat
エクスポートされたファイルの要求された形式
| 名前 | 型 | 説明 |
|---|---|---|
| ACCESSIBLEPDF |
string |
アクセシビリティの高い PDF (ページ分割されたレポートでのみサポート) |
| CSV |
string |
CSV (ページ分割されたレポートでのみサポート) |
| DOCX |
string |
Microsoft Word (ページ分割されたレポートでのみサポート) |
| IMAGE |
string |
BMP、EMF、GIF、JPEG、PNG、または TIFF イメージ 形式 (ページ分割されたレポートでのみサポート) |
| MHTML |
string |
MHTML (ページ分割されたレポートでのみサポート) |
|
string |
|
|
| PNG |
string |
PNG (Power BI レポートでのみサポート) |
| PPTX |
string |
Microsoft PowerPoint |
| XLSX |
string |
Microsoft Excel (ページ分割されたレポートでのみサポート) |
| XML |
string |
XML (ページ分割されたレポートでのみサポート) |
IdentityBlob
ID を指定するための BLOB。 Azure SQL への DirectQuery 接続を持つデータセットでのみサポートされます
| 名前 | 型 | 説明 |
|---|---|---|
| value |
string |
Azure SQLの OAuth 2.0 アクセス トークン |
PageBookmark
1 つのページに適用するブックマーク。 名前または状態を指定しますが、両方は指定しないでください。
| 名前 | 型 | 説明 |
|---|---|---|
| name |
string |
ブックマーク名 |
| state |
string |
ブックマークの状態 |
PaginatedReportExportConfiguration
ページ分割されたレポートのファイルへのエクスポート構成
| 名前 | 型 | 説明 |
|---|---|---|
| formatSettings |
object |
書式設定のディクショナリ。 キーは、要求されたファイル形式のデバイス情報プロパティ名です。 |
| identities |
レポートをエクスポートするときに使用する 1 つの ID。 レポートで Power BI データセットまたはAzure Analysis Services データ ソースを使用する場合に必要です。 |
|
| parameterValues |
レポート パラメーターの一覧 |
ParameterValue
ページ分割されたレポート パラメーターのデータ コントラクト
| 名前 | 型 | 説明 |
|---|---|---|
| name |
string |
パラメーター名 |
| value |
string |
パラメーター値 |
PowerBIReportExportConfiguration
Power BI レポートのファイルへのエクスポート構成
| 名前 | 型 | 説明 |
|---|---|---|
| datasetToBind |
string |
レポートをエクスポートするデータセット ID。 レポートの既定のデータセット以外のデータセットでエクスポートする場合にのみ必要です。 |
| defaultBookmark |
特定のブックマークを持たないすべてのページに適用する既定のブックマーク |
|
| identities |
行レベルのセキュリティ規則に使用する ID の一覧 |
|
| pages |
エクスポートするページとそのプロパティの一覧。 同じページが異なるビジュアルで複数回表示される場合があります。 |
|
| reportLevelFilters |
適用するレポート レベル フィルターの一覧。 現在、サポートされているフィルターは 1 つだけです。 |
|
| settings |
ファイル ジョブへのエクスポートに適用する設定 |