Datasets - Update Refresh Schedule In Group

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

Request Body

Responses

Examples

Change the days and times of a refresh schedule example

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

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

Change the notification option of a refresh schedule example

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

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

Disable a scheduled refresh example

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

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

Update the times of a refresh schedule example

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

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

Definitions

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.