Reports - Get Export To File Status In Group

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

指定したワークスペースから指定したレポートの [ グループ内のファイルにエクスポート] ジョブの現在の状態を返します。

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

アクセス許可

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

必要なスコープ

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

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

URI パラメーター

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

応答

名前	型	説明
200 OK	Export	OK
202 Accepted	Export	同意

例

Example

Sample Request

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

Sample Response

Status code:: 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

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

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

ExportState

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

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