Datasets - Update Refresh Schedule In Group

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

This operation is only supported for the dataset owner.
A request that disables the refresh schedule should contain no other changes.
The days array should not be set to empty array.
The times may be set to empty array (in which case Power BI will use a default single time per day).
The limit on number of time slots per day depends on the type of capacity used (Premium or Shared), see What is Microsoft Power BI Premium.

Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.

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

URI Parameters

Name In Required Type Description
groupId
path True
  • string
uuid

The workspace id

datasetId
path True
  • string

The dataset id

Request Body

Name Required Type Description
value True

An object containg the refresh schedule details

Responses

Name Type Description
200 OK

OK

Examples

change days and times
change notification option
disable scheduled refresh
update times

change days and times

Sample Request

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"
  }
}

Sample Response

change notification option

Sample Request

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

Sample Response

disable scheduled refresh

Sample Request

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

Sample Response

update times

Sample Request

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"
    ]
  }
}

Sample Response

Definitions

RefreshSchedule

A Power BI refresh schedule for cached model

RefreshScheduleRequest

Power BI refresh schedule request

ScheduleNotifyOption

Notification option at scheduled refresh termination

RefreshSchedule

A Power BI refresh schedule for cached model

Name Type Description
NotifyOption

Notification option at scheduled refresh termination

days
  • string[]

Days to execute the refresh

enabled
  • boolean

Is the refresh enabled

localTimeZoneId
  • string

The Id of the Time zone to use. See Name of Time Zone column in Microsoft Time Zone Index Values.

times
  • string[]

Times to execute the refresh within each day

RefreshScheduleRequest

Power BI refresh schedule request

Name Type Description
value

An object containg the refresh schedule details

ScheduleNotifyOption

Notification option at scheduled refresh termination

Name Type Description
MailOnFailure
  • string

Mail notification will be sent on refresh failure

NoNotification
  • string

No notification will be sent