Datasets - Update Refresh Schedule

  • Ссылка
Service:
Power BI REST APIs
API Version:
v1.0

Обновления расписание обновления для указанного набора данных из раздела Моя рабочая область.

Запрос, отключающий расписание обновления, не должен содержать других изменений.

Необходимо указать хотя бы один день. Если время не указано, Power BI будет использовать по умолчанию один раз в день.

Разрешения

Пользователь должен быть владельцем набора данных.

Требуемая область

Dataset.ReadWrite.All

Ограничения

Ограничение на количество временных интервалов в день зависит от того, используется ли емкость Premium или Общая. 

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

Параметры URI

Имя В Обязательно Тип Описание
datasetId
 path True

string

Идентификатор набора данных

Текст запроса

Имя Обязательно Тип Описание
value True

RefreshSchedule

Объект , содержащий сведения о расписании обновления.

Ответы

Имя Тип Описание
200 OK

ОК

Примеры

Change the days and times of a refresh schedule example
Change the notification option of a refresh schedule example
Disable a scheduled refresh example
Update the times of a refresh schedule example

Change the days and times of a refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule
Request Body
{
  "value": {
    "days": [
      "Sunday",
      "Tuesday",
      "Friday",
      "Saturday"
    ],
    "times": [
      "07:00",
      "11:30",
      "16:00",
      "23:30"
    ],
    "localTimeZoneId": "UTC"
  }
}

Sample Response

Status code:
200

Change the notification option of a refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule
Request Body
{
  "value": {
    "notifyOption": "NoNotification"
  }
}

Sample Response

Status code:
200

Disable a scheduled refresh example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule
Request Body
{
  "value": {
    "enabled": false
  }
}

Sample Response

Status code:
200

Update the times of a refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule
Request Body
{
  "value": {
    "times": [
      "08:00",
      "16:00"
    ]
  }
}

Sample Response

Status code:
200

Определения

Имя Описание
days

Дни, в которые выполняется обновление
RefreshSchedule

Расписание обновления Power BI для импортированной модели
RefreshScheduleRequest

Запрос расписания обновления Power BI
ScheduleNotifyOption

Параметр уведомления о завершении запланированного обновления. Субъекты-службы поддерживают NoNotification только значение .

days

Дни, в которые выполняется обновление

Имя Тип Описание
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

RefreshSchedule

Расписание обновления Power BI для импортированной модели

Имя Тип Описание
NotifyOption

ScheduleNotifyOption

Параметр уведомления о завершении запланированного обновления. Субъекты-службы поддерживают NoNotification только значение .
days

days[]

Дни, в которые выполняется обновление
enabled

boolean

Включено ли обновление
localTimeZoneId

string

Идентификатор используемого часового пояса. Дополнительные сведения см. в разделе Сведения о часовом поясе.
times

string[]

Время суток для выполнения обновления

RefreshScheduleRequest

Запрос расписания обновления Power BI

Имя Тип Описание
value

RefreshSchedule

Объект , содержащий сведения о расписании обновления.

ScheduleNotifyOption

Параметр уведомления о завершении запланированного обновления. Субъекты-службы поддерживают NoNotification только значение .

Имя Тип Описание
MailOnFailure

string

При сбое обновления будет отправлено уведомление по почте.
NoNotification

string

Уведомления не отправляются