Dataflows - Refresh Dataflow

サービス:
Power BI REST APIs
API バージョン:
v1.0

指定したデータフローの更新をトリガーします。

サポートされているメール通知オプションは 、MailOnFailure と NoNotification です。 MailOnCompletion はサポートされていません。

Permissions

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

必要なスコープ

Dataflow.ReadWrite.All 

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows/{dataflowId}/refreshes
省略可能なパラメーターを含む: 
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows/{dataflowId}/refreshes?processType={processType}

URI パラメーター

名前 / 必須 型 説明
dataflowId
 path True

string (uuid)

データフロー ID
groupId
 path True

string (uuid)

ワークスペース ID
processType
 query

string

使用する更新プロセスの種類。

要求本文

名前 必須 型 説明
notifyOption True

NotifyOption

メール通知オプション

応答

名前 型 説明
200 OK

[OK]

例

Example

要求のサンプル

POST https://api.powerbi.com/v1.0/myorg/groups/51e47fc5-48fd-4826-89f0-021bd3a80abd/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshes?processType=default
要求本文
{
  "notifyOption": "MailOnFailure"
}

応答のサンプル

状態コード:
200

定義

名前 説明
NotifyOption

メール通知オプション
RefreshRequest

Power BI の更新要求

NotifyOption

列挙

メール通知オプション

値 説明
NoNotification

通知は送信されません
MailOnFailure

更新エラー時にメール通知が送信される
MailOnCompletion

更新の完了時に成功または失敗を示すメール通知が送信される

RefreshRequest

Object

Power BI の更新要求

名前 型 説明
notifyOption

NotifyOption

メール通知オプション