Datasets - Update Direct Query Refresh Schedule In Group

Updates the refresh schedule for a specified DirectQuery or LiveConnection dataset from the specified workspace.

A request should contain either a set of days and times or a valid frequency, but not both. If you choose a set of days without specifying any times, then Power BI will use a default single time per day. Setting the frequency will automatically overwrite the days and times setting.

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

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

URI Parameters

Request Body

Responses

Examples

Set a days and times based schedule example

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

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

Set a frequency based schedule example

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

{
  "value": {
    "frequency": 30
  }
}

Update the times of an existing days and times based schedule example

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

{
  "value": {
    "times": [
      "07:00",
      "16:30",
      "23:30"
    ]
  }
}

Definitions

days

The days on which to execute the refresh

DirectQueryRefreshSchedule

A Power BI refresh schedule for DirectQuery or LiveConnection, specifying either the frequency or a combination of days and times.

DirectQueryRefreshScheduleRequest

Power BI refresh schedule request for DirectQuery or LiveConnection