Datasets - Get Refresh Schedule In Group

Returns the refresh schedule of the specified dataset from the specified workspace.

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

GET 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

Responses

Name Type Description
200 OK

OK

Examples

Refresh Schedule example

Sample Request

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

Sample Response

{
  "value": {
    "days": [
      "Sunday",
      "Friday",
      "Saturday"
    ],
    "times": [
      "05:00",
      "11:30",
      "17:30",
      "23:00"
    ],
    "enabled": true,
    "localTimeZoneId": "UTC",
    "notifyOption": "MailOnFailure"
  }
}

Definitions

RefreshSchedule

A Power BI refresh schedule for cached model

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

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