Поделиться через

Dataflows - Update Refresh Schedule

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

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

Разрешения

Этот вызов 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

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule
Request Body
{
  "value": {
    "days": [
      "Sunday",
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday"
    ],
    "times": [
      "10:00",
      "16:00"
    ],
    "enabled": true,
    "localTimeZoneId": "UTC",
    "notifyOption": "NoNotification"
  }
}

Sample Response

Status code:
200

Disable refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule
Request Body
{
  "value": {
    "enabled": false
  }
}

Sample Response

Status code:
200

Update refresh schedule times example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule
Request Body
{
  "value": {
    "times": [
      "10:30",
      "16:30"
    ],
    "enabled": true,
    "localTimeZoneId": "UTC"
  }
}

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

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