Datasets - Get Refresh Schedule In Group

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

Required scope

Dataset.ReadWrite.All or Dataset.Read.All

GET 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

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

{
  "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 imported model

ScheduleNotifyOption

The notification option on termination of a scheduled refresh

RefreshSchedule

A Power BI refresh schedule for imported model

Name Type Description
NotifyOption

The notification option on termination of a scheduled refresh

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

ScheduleNotifyOption

The notification option on termination of a scheduled refresh

Name Type Description
MailOnFailure
  • string

A mail notification will be sent on refresh failure

NoNotification
  • string

No notification will be sent