Datasets - Get Refresh History In Group

Service:

Power BI REST APIs

API Version:

v1.0

指定したワークスペースから、指定したデータセットの更新履歴を返します。

アクセス許可

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

必要なスコープ

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

制限事項

OneDrive の更新履歴は返されません。

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/refreshes

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}/refreshes?$top={$top}

URI パラメーター

名前	/	必須	型	説明
datasetId	path	True	string	データセット ID
groupId	path	True	string uuid	ワークスペース ID
$top	query		integer	更新履歴で要求されたエントリ数。 指定しない場合、既定値は最後に使用可能な 60 個のエントリです。

応答

名前	型	説明
200 OK	Refreshes	OK

例

Completed refresh example

Failed refresh example

In-progress refresh example

Completed refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes?$top=1

Sample Response

Status code:

200

{
  "value": [
    {
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-13T09:31:43.153Z",
      "status": "Completed",
      "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1",
      "refreshAttempts": [
        {
          "attemptId": 1,
          "startTime": "2017-06-13T09:25:43.153Z",
          "endTime": "2017-06-13T09:31:40.153Z",
          "type": "Data"
        },
        {
          "attemptId": 1,
          "startTime": "2017-06-13T09:31:40.156Z",
          "endTime": "2017-06-13T09:31:43.153Z",
          "type": "Query"
        }
      ]
    }
  ]
}

Failed refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes?$top=1

Sample Response

Status code:

200

{
  "value": [
    {
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-13T09:31:43.153Z",
      "serviceExceptionJson": "{\"errorCode\":\"ModelRefreshFailed_CredentialsNotSpecified\"}",
      "status": "Failed",
      "requestId": "11bf290a-346b-48b7-8973-c5df149337ff",
      "refreshAttempts": [
        {
          "attemptId": 1,
          "startTime": "2017-06-13T09:25:43.153Z",
          "endTime": "2017-06-13T09:31:43.153Z",
          "serviceExceptionJson": "{\"errorCode\":\"ModelRefreshFailed_CredentialsNotSpecified\"}",
          "type": "Data"
        }
      ]
    }
  ]
}

In-progress refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes?$top=1

Sample Response

Status code:

200

{
  "value": [
    {
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "status": "Unknown",
      "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
    }
  ]
}

定義

名前	説明
Refresh	Power BI 更新履歴エントリ
RefreshAttempt	Power BI は、更新エラーが発生した場合に、データセットの更新を複数回試行します。 このオブジェクトには、各更新試行に関する情報が含まれます。
RefreshAttemptType	更新の試行の種類。
Refreshes	Power BI 更新履歴リストの OData 応答ラッパー
RefreshType	更新要求の種類

Refresh

Power BI 更新履歴エントリ

名前	型	説明
endTime	string	更新の終了日時 (更新が進行中の場合は空の場合があります)
refreshAttempts	RefreshAttempt[]	更新の試行の一覧。
refreshType	RefreshType	更新要求の種類
requestId	string	更新要求の識別子。 すべてのサービス要求でこの識別子を指定します。
serviceExceptionJson	string	JSON 形式のエラー エラー コード (エラーがない場合は空)
startTime	string	更新の開始日時
status	string	Unknown 完了状態が不明な場合、または更新が進行中の場合は 。 Completed 正常に完了した更新の場合は 。 Failed 失敗した更新の場合 (serviceExceptionJson にはエラー コードが含まれます)。 Disabled 選択的更新によって更新が無効になっている場合は 。

RefreshAttempt

Power BI は、更新エラーが発生した場合に、データセットの更新を複数回試行します。 このオブジェクトには、各更新試行に関する情報が含まれます。

名前	型	説明
attemptId	integer	更新の試行のインデックス。
endTime	string	更新の試行の終了日時。 更新の試行が進行中の場合、値は void です。
serviceExceptionJson	string	JSON 形式のエラー エラー コード。 エラーがない場合は Void。
startTime	string	更新試行の開始日時。
type	RefreshAttemptType	更新の試行の種類。

RefreshAttemptType

更新の試行の種類。

名前	型	説明
Data	string	更新では、データセットにデータを読み込もうとします。
Query	string	Premium クエリ キャッシュとダッシュボード タイルの更新の試行。u

Refreshes

Power BI 更新履歴リストの OData 応答ラッパー

名前	型	説明
odata.context	string
value	Refresh[]	更新履歴の一覧

RefreshType

更新要求の種類

名前	型	説明
OnDemand	string	更新は Power BI ポータルを介して対話形式でトリガーされました
OnDemandTraining	string	更新は、自動集計トレーニングを使用して Power BI ポータルを介して対話形式でトリガーされました
Scheduled	string	データセットの更新スケジュール設定によって更新がトリガーされました
ViaApi	string	更新は API 呼び出しによってトリガーされました
ViaEnhancedApi	string	更新は、強化された更新 REST API 呼び出しによってトリガーされました
ViaXmlaEndpoint	string	更新は、Power BI パブリック XMLA エンドポイントを介してトリガーされました