Reports - Export To File In Group

サービス:

Power BI REST APIs

API バージョン:

v1.0

指定したレポートを指定したワークスペースから、要求された ファイル形式エクスポートします。

API は非同期です。 API が呼び出されると、エクスポート ジョブがトリガーされます。 エクスポート ジョブをトリガーした後、GetExportToFileStatus API 使用してジョブの状態を追跡します。 フロー全体の詳細については、Power BI レポートのエクスポート とページ分割されたレポートのエクスポート

権限

この API 呼び出しは、サービス プリンシパル プロファイルによって呼び出すことができます。 詳細については、「Power BI Embeddedでのサービス プリンシパル プロファイルの 」を参照してください。

必要なスコープ

次のすべて:

• Report.ReadWrite.All または Report.Read.All
• Dataset.ReadWrite.All または Dataset.Read.All

制限事項

Power BI レポートをファイル にエクスポートする およびページ分割されたレポートをファイル にエクスポートするの制限事項を確認します。

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

URI パラメーター

名前	/	必須	型	説明
groupId	path	True	string (uuid)	ワークスペース ID
reportId	path	True	string (uuid)	レポート ID

要求本文

名前	必須	型	説明
format	True	FileFormat	エクスポートされたファイルの要求された形式
paginatedReportConfiguration		PaginatedReportExportConfiguration	ページ分割されたレポートのエクスポートに使用される構成
powerBIReportConfiguration		PowerBIReportExportConfiguration	Power BI レポートのエクスポートに使用される構成

応答

名前	型	説明
202 Accepted	Export	受け入れられた

定義

名前	説明
EffectiveIdentity	ユーザー ID とロールを定義します。 詳細については、「Power BI Embeddedを使用した行レベルのセキュリティ」を参照してください。
Export	ファイル ジョブへのエクスポートの詳細と現在の状態を記述するオブジェクト
ExportFilter	エクスポート操作中に適用されるフィルター
ExportReportPage	エクスポート要求の単一ページ構成
ExportReportRequest	ファイルへのエクスポート要求
ExportReportSettings	ファイル要求設定へのエクスポート
ExportState	ファイル ジョブへのエクスポートの現在の状態
FileFormat	エクスポートされたファイルの要求された形式
IdentityBlob	ID を指定するための BLOB。 Azure SQL への DirectQuery 接続を持つデータセットでのみサポートされます
PageBookmark	1 つのページに適用するブックマーク。 名前または状態を指定しますが、両方は指定しないでください。
PaginatedReportExportConfiguration	ページ分割されたレポートのファイルへのエクスポート構成
ParameterValue	ページ分割されたレポート パラメーターのデータ コントラクト
PowerBIReportExportConfiguration	Power BI レポートのファイルへのエクスポート構成

EffectiveIdentity

Object

ユーザー ID とロールを定義します。 詳細については、「Power BI Embeddedを使用した行レベルのセキュリティ」を参照してください。

名前	型	説明
auditableContext	string	EffectiveIdentity 監査可能なコンテキスト。 このパラメーターが指定され、空でない場合は、EffectiveIdentity の監査が有効になり、その値は監査レコードのユーザー名に設定されます。 それ以外の場合、EffectiveIdentity コンテキストは GenerateToken 監査レコードから省略されます。
customData	string	行レベルのセキュリティ規則の適用に使用されるカスタム データ。 Azure Analysis Services モデルとクラウド モデルへのライブ接続でのみサポートされます。
datasets	string[]	この ID が適用されるデータセットの配列
identityBlob	IdentityBlob	IDを指定する BLOB。 Azure SQL への DirectQuery 接続を持つデータセットでのみサポートされます。
reports	string[]	この ID が適用されるレポートの配列。 ページ分割されたレポートでのみサポートされます。
roles	string[]	RLS ルールを適用するトークン内の行レベル セキュリティ (RLS) ロールの配列。 ID には、最大 50 個のロールを含めることができます。 ロールには、,を除く任意の文字を含めることができます。その長さは 50 文字を超えてはなりません。
username	string	行レベルのセキュリティ規則を適用するトークン内の有効なユーザー名。 オンプレミス モデルの場合、ユーザー名には、英数字、または次のいずれかの文字 .、-、_、!、#、^、~、\\、@を含めることができます。 クラウド モデルの場合、ユーザー名には任意の ASCII 文字を含めることができます。 どちらのモデルでも、ユーザー名の長さは 256 文字を超えてはなりません。また、ユーザー名にはスペースを含めてはなりません。

Export

Object

ファイル ジョブへのエクスポートの詳細と現在の状態を記述するオブジェクト

名前	型	説明
createdDateTime	string (date-time)	ファイル へのエクスポート ジョブの開始日時
expirationTime	string (date-time)	取得 URL の有効期限の日付と時刻
id	string	ファイル へのエクスポート ジョブ ID
lastActionDateTime	string (date-time)	ファイルへのエクスポート ジョブに対する最後の変更の日時
percentComplete	integer (int32) minimum: 0 maximum: 100	ジョブの進行状況 (パーセンテージ)
reportId	string (uuid)	エクスポートされたレポートの ID
reportName	string	エクスポートされたレポートの名前
resourceFileExtension	string	エクスポートされたファイルの拡張子
resourceLocation	string	エクスポートされたファイルの取得 URL
status	ExportState	ファイル ジョブへのエクスポートの現在の状態

ExportFilter

Object

エクスポート操作中に適用されるフィルター

名前	型	説明
filter	string	適用するフィルター。 フィルター構文の詳細については、「レポートをフィルター処理する」を参照してください。

ExportReportPage

Object

エクスポート要求の単一ページ構成

名前	型	説明
bookmark	PageBookmark	ページに適用するブックマーク
pageName	string	ページ名
visualName	string	エクスポートするビジュアルの名前。 このページのビジュアルが 1 つだけエクスポートされる場合は、名前を指定します。

ExportReportRequest

Object

ファイルへのエクスポート要求

名前	型	説明
format	FileFormat	エクスポートされたファイルの要求された形式
paginatedReportConfiguration	PaginatedReportExportConfiguration	ページ分割されたレポートのエクスポートに使用される構成
powerBIReportConfiguration	PowerBIReportExportConfiguration	Power BI レポートのエクスポートに使用される構成

ExportReportSettings

Object

ファイル要求設定へのエクスポート

名前	型	説明
includeHiddenPages	boolean	レポート全体をエクスポートするときに非表示のページを含めるかどうか。 指定しない場合、既定の動作では非表示ページが除外されます。 このプロパティは、特定のページがエクスポートされるときに無視されます。
locale	string	適用するロケール

ExportState

列挙

ファイル ジョブへのエクスポートの現在の状態

値	説明
Failed	ファイルへのエクスポート ジョブが失敗しました
NotStarted	ファイルへのエクスポート ジョブが開始されませんでした
Running	ファイルへのエクスポート ジョブが実行されている
Succeeded	ファイルへのエクスポート ジョブが正常に完了しました
Undefined	ファイル へのエクスポート ジョブの状態が未定義です

FileFormat

列挙

エクスポートされたファイルの要求された形式

値	説明
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

ID を指定するための BLOB。 Azure SQL への DirectQuery 接続を持つデータセットでのみサポートされます

名前	型	説明
value	string	Azure SQL の OAuth 2.0 アクセス トークン

PageBookmark

Object

1 つのページに適用するブックマーク。 名前または状態を指定しますが、両方は指定しないでください。

名前	型	説明
name	string	ブックマーク名
state	string	ブックマークの状態

PaginatedReportExportConfiguration

Object

ページ分割されたレポートのファイルへのエクスポート構成

名前	型	説明
formatSettings	object	書式設定のディクショナリ。 キーは、要求されたファイル形式のデバイス情報プロパティ名です。
identities	EffectiveIdentity[]	レポートをエクスポートするときに使用する 1 つの ID。 レポートで Power BI データセットまたは Azure Analysis Services データ ソースを使用する場合に必要です。
locale	string	適用するロケール
parameterValues	ParameterValue[]	レポート パラメーターの一覧

ParameterValue

Object

ページ分割されたレポート パラメーターのデータ コントラクト

名前	型	説明
name	string	パラメーター名
value	string	パラメーター値

PowerBIReportExportConfiguration

Object

Power BI レポートのファイルへのエクスポート構成

名前	型	説明
datasetToBind	string	レポートのエクスポートに使用するデータセット ID。 レポートの既定のデータセット以外のデータセットを使用してエクスポートする場合にのみ必要です。
defaultBookmark	PageBookmark	特定のブックマークがないすべてのページに適用される既定のブックマーク
identities	EffectiveIdentity[]	行レベルのセキュリティ規則に使用する ID の一覧
pages	ExportReportPage[]	エクスポートするページとそのプロパティの一覧。 同じページが複数表示され、ビジュアルが異なる場合があります。
reportLevelFilters	ExportFilter[]	適用するレポート レベル フィルターの一覧。 現在、サポートされているフィルターは 1 つだけです。
settings	ExportReportSettings	ファイル へのエクスポート ジョブに適用する設定