Dataflows - Update Refresh Schedule

Service:

Power BI REST APIs

API Version:

v1.0

Creates or updates the refresh schedule for a specified dataflow.

Permissions

This API call can be called by a service principal profile. For more information see: Service principal profiles in Power BI Embedded.

Required Scope

Dataflow.ReadWrite.All

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

URI Parameters

Name	In	Required	Type	Description
dataflowId	path	True	string uuid	The dataflow ID
groupId	path	True	string uuid	The workspace ID

Request Body

Name	Required	Type	Description
value	True	RefreshSchedule	An object that contains the details of a refresh schedule

Responses

Name	Type	Description
200 OK		OK

Examples

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

Definitions

Name	Description
days	The days on which to execute the refresh
RefreshSchedule	A Power BI refresh schedule for imported model
RefreshScheduleRequest	Power BI refresh schedule request
ScheduleNotifyOption	The notification option on termination of a scheduled refresh. Service principals only support the NoNotification value.

days

The days on which to execute the refresh

Name	Type	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

RefreshSchedule

A Power BI refresh schedule for imported model

Name	Type	Description
NotifyOption	ScheduleNotifyOption	The notification option on termination of a scheduled refresh. Service principals only support the NoNotification value.
days	days[]	The days on which to execute the refresh
enabled	boolean	Whether the refresh is enabled
localTimeZoneId	string	The ID of the time zone to use. For more information, see Time zone info.
times	string[]	The times of day to execute the refresh

RefreshScheduleRequest

Power BI refresh schedule request

Name	Type	Description
value	RefreshSchedule	An object that contains the details of a refresh schedule

ScheduleNotifyOption

The notification option on termination of a scheduled refresh. Service principals only support the NoNotification value.

Name	Type	Description
MailOnFailure	string	A mail notification will be sent on refresh failure
NoNotification	string	No notification will be sent