Datasets - Get Refresh Schedule

Service:

Power BI REST APIs

API Version:

v1.0

Returns the refresh schedule for the specified dataset from My workspace.

Required Scope

Dataset.ReadWrite.All or Dataset.Read.All

GET https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/refreshSchedule

URI Parameters

Name	In	Required	Type	Description
datasetId	path	True	string	The dataset ID

Responses

Name	Type	Description
200 OK	RefreshSchedule	OK

Examples

Refresh schedule example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule

Sample Response

Status code:

200

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

Definitions

Name	Description
days	The days on which to execute the refresh
RefreshSchedule	A Power BI refresh schedule for imported model
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

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