Dataflows - Update Refresh Schedule

Служба:

Power BI REST APIs

Версия API:

v1.0

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

Permissions

Этот вызов API может вызываться профилем субъекта-службы. Дополнительные сведения см. в разделе "Профили субъектов-служб" в Power BI Embedded.

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

Dataflow.ReadWrite.All

PATCH https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows/{dataflowId}/refreshSchedule

Параметры URI

Имя	В	Обязательно	Тип	Описание
dataflowId	path	True	string (uuid)	Идентификатор потока данных
groupId	path	True	string (uuid)	Идентификатор рабочей области

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

Имя	Обязательно	Тип	Описание
value	True	RefreshSchedule	Объект, содержащий сведения о расписании обновления

Ответы

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

Примеры

Daily refresh schedule example

Disable refresh schedule example

Update refresh schedule times example

Daily refresh schedule example

Образец запроса

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule

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

{
  "value": {
    "days": [
      "Sunday",
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday"
    ],
    "times": [
      "10:00",
      "16:00"
    ],
    "enabled": true,
    "localTimeZoneId": "UTC",
    "notifyOption": "NoNotification"
  }
}

Пример ответа

Код состояния:

200

Disable refresh schedule example

Образец запроса

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule

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

{
  "value": {
    "enabled": false,
    "times": [],
    "localTimeZoneId": "UTC"
  }
}

Пример ответа

Код состояния:

200

Update refresh schedule times example

Образец запроса

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule

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

{
  "value": {
    "times": [
      "10:30",
      "16:30"
    ],
    "enabled": true,
    "localTimeZoneId": "UTC"
  }
}

Пример ответа

Код состояния:

200

Определения

Имя	Описание
days	Дни выполнения обновления
RefreshSchedule	Расписание обновления Power BI для импортированной модели
RefreshScheduleRequest	Запрос на обновление Power BI
ScheduleNotifyOption	Параметр уведомления о завершении запланированного обновления. Субъекты-службы поддерживают NoNotification только значение.

days

Перечисление

Дни выполнения обновления

Значение	Описание
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

RefreshSchedule

Object

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

Имя	Тип	Описание
days	days[]	Дни выполнения обновления
enabled	boolean	Включена ли обновление
localTimeZoneId	string	Идентификатор используемого часового пояса. Дополнительные сведения см. в разделе " Сведения о часовом поясе".
notifyOption	ScheduleNotifyOption	Параметр уведомления о завершении запланированного обновления. Субъекты-службы поддерживают NoNotification только значение.
times	string[]	Время суток для выполнения обновления

RefreshScheduleRequest

Object

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

Имя	Тип	Описание
value	RefreshSchedule	Объект, содержащий сведения о расписании обновления

ScheduleNotifyOption

Перечисление

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

Значение	Описание
NoNotification	Уведомление не будет отправлено
MailOnFailure	Уведомление по почте будет отправлено при сбое обновления