Reports - Get Export To File Status

サービス:

Power BI REST APIs

API バージョン:

v1.0

指定したレポートの Export to File ジョブの現在の状態を マイ ワークスペースから返します。

エクスポート ジョブの状態が "成功" の場合は、GetFileOfExportToFile API を使用してファイルを取得します。

必要なスコープ

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

GET https://api.powerbi.com/v1.0/myorg/reports/{reportId}/exports/{exportId}

URI パラメーター

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

応答

名前	型	説明
200 OK	Export	わかりました
202 Accepted	Export	受け入れられた

例

Example

要求のサンプル

GET https://api.powerbi.com/v1.0/myorg/reports/{reportId}/exports/{exportId}

応答のサンプル

状態コード:

200

{
  "id": "Mi9C5419i....PS4=",
  "createdDateTime": "2021-12-08T10:26:09.3069086Z",
  "lastActionDateTime": "2021-12-08T10:26:38.016851Z",
  "reportId": "cad51cfa-e740-324f-acbb-8ca43c40a2d4",
  "reportName": "Report name",
  "status": "Succeeded",
  "percentComplete": 100,
  "resourceLocation": "...Mi9C5419i....PS4=/file",
  "resourceFileExtension": ".pptx",
  "expirationTime": "2021-12-09T10:26:11.586756Z"
}

定義

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

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	ファイル ジョブへのエクスポートの現在の状態

ExportState

列挙

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

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