Dataflows - Update Refresh Schedule

Service:

Power BI REST APIs

API Version:

v1.0

建立或更新指定資料流程的重新整理排程。

權限

此 API 呼叫可由服務主體設定檔呼叫。 如需詳細資訊，請參閱：Power BI Embedded中的服務主體設定檔。

必要範圍

Dataflow.ReadWrite.All

PATCH https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows/{dataflowId}/refreshSchedule

URI 參數

名稱	位於	必要	類型	Description
dataflowId	path	True	string uuid	資料流程識別碼
groupId	path	True	string uuid	工作區識別碼

要求本文

名稱	必要	類型	Description
value	True	RefreshSchedule	物件，包含重新整理排程的詳細資料

回應

名稱	類型	Description
200 OK		確定

範例

Daily refresh schedule example

Disable refresh schedule example

Update refresh schedule times example

Daily refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule

Request Body

{
  "value": {
    "days": [
      "Sunday",
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday"
    ],
    "times": [
      "10:00",
      "16:00"
    ],
    "enabled": true,
    "localTimeZoneId": "UTC",
    "notifyOption": "NoNotification"
  }
}

Sample Response

Status code:

200

Disable refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule

Request Body

{
  "value": {
    "enabled": false
  }
}

Sample Response

Status code:

200

Update refresh schedule times example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule

Request Body

{
  "value": {
    "times": [
      "10:30",
      "16:30"
    ],
    "enabled": true,
    "localTimeZoneId": "UTC"
  }
}

Sample Response

Status code:

200

定義

名稱	Description
days	要執行重新整理的天數
RefreshSchedule	匯入模型的Power BI 重新整理排程
RefreshScheduleRequest	Power BI 重新整理排程要求
ScheduleNotifyOption	排程重新整理終止的通知選項。 服務主體僅支援 NoNotification 值。

days

要執行重新整理的天數

名稱	類型	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

RefreshSchedule

匯入模型的Power BI 重新整理排程

名稱	類型	Description
NotifyOption	ScheduleNotifyOption	排程重新整理終止的通知選項。 服務主體僅支援 NoNotification 值。
days	days[]	要執行重新整理的天數
enabled	boolean	是否啟用重新整理
localTimeZoneId	string	要使用的時區識別碼。 如需詳細資訊，請參閱 時區資訊。
times	string[]	執行重新整理的一天時間

RefreshScheduleRequest

Power BI 重新整理排程要求

名稱	類型	Description
value	RefreshSchedule	物件，包含重新整理排程的詳細資料

ScheduleNotifyOption

排程重新整理終止的通知選項。 服務主體僅支援 NoNotification 值。

名稱	類型	Description
MailOnFailure	string	重新整理失敗時會傳送郵件通知
NoNotification	string	不會傳送通知