Datasets - Update Refresh Schedule In Group

Service:

Power BI REST APIs

API Version:

v1.0

Updates the refresh schedule for the specified dataset from the specified workspace.

A request that disables the refresh schedule should contain no other changes.

At least one day must be specified. If no times are specified, then Power BI will use a default single time per day.

Permissions

• The user must be the dataset owner.
• This API call can be called by a service principal profile. For more information see: Service principal profiles in Power BI Embedded.

Required Scope

Dataset.ReadWrite.All

Limitations

The limit on the number of time slots per day depends on whether a Premium or Shared capacity is used.

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

URI Parameters

Name	In	Required	Type	Description
datasetId	path	True	string	The dataset 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

Change the days and times of a refresh schedule example

Change the notification option of a refresh schedule example

Disable a scheduled refresh example

Update the times of a refresh schedule example

Change the days and times of a refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule

Request Body

{
  "value": {
    "days": [
      "Sunday",
      "Tuesday",
      "Friday",
      "Saturday"
    ],
    "times": [
      "07:00",
      "11:30",
      "16:00",
      "23:30"
    ],
    "localTimeZoneId": "UTC"
  }
}

Sample Response

Status code:

200

Change the notification option of a refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule

Request Body

{
  "value": {
    "notifyOption": "NoNotification"
  }
}

Sample Response

Status code:

200

Disable a scheduled refresh example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule

Request Body

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

Sample Response

Status code:

200

Update the times of a refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule

Request Body

{
  "value": {
    "times": [
      "08:00",
      "16:00"
    ]
  }
}

Sample Response

Status code:

200

Definitions

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.

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	string[]	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