Dataflows - Update Refresh Schedule

Service:

Power BI REST APIs

API Version:

v1.0

Tworzy lub aktualizuje harmonogram odświeżania dla określonego przepływu danych.

Uprawnienia

To wywołanie interfejsu API może być wywoływane przez profil jednostki usługi. Aby uzyskać więcej informacji, zobacz: Profile jednostki usługi w Power BI Embedded.

Wymagany zakres

Dataflow.ReadWrite.All

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
dataflowId	path	True	string uuid	Identyfikator przepływu danych
groupId	path	True	string uuid	Identyfikator obszaru roboczego

Treść żądania

Nazwa	Wymagane	Typ	Opis
value	True	RefreshSchedule	Obiekt zawierający szczegóły harmonogramu odświeżania

Odpowiedzi

Nazwa	Typ	Opis
200 OK		OK

Przykłady

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

Definicje

Nazwa	Opis
days	Dni, w których należy wykonać odświeżanie
RefreshSchedule	Harmonogram odświeżania usługi Power BI dla zaimportowanego modelu
RefreshScheduleRequest	Żądanie harmonogramu odświeżania usługi Power BI
ScheduleNotifyOption	Opcja powiadomienia po zakończeniu zaplanowanego odświeżania. Jednostki usługi obsługują NoNotification tylko wartość.

days

Dni, w których należy wykonać odświeżanie

Nazwa	Typ	Opis
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

RefreshSchedule

Harmonogram odświeżania usługi Power BI dla zaimportowanego modelu

Nazwa	Typ	Opis
NotifyOption	ScheduleNotifyOption	Opcja powiadomienia po zakończeniu zaplanowanego odświeżania. Jednostki usługi obsługują NoNotification tylko wartość.
days	days[]	Dni, w których należy wykonać odświeżanie
enabled	boolean	Czy odświeżanie jest włączone
localTimeZoneId	string	Identyfikator strefy czasowej do użycia. Aby uzyskać więcej informacji, zobacz Informacje o strefie czasowej.
times	string[]	Czasy dnia do wykonania odświeżania

RefreshScheduleRequest

Żądanie harmonogramu odświeżania usługi Power BI

Nazwa	Typ	Opis
value	RefreshSchedule	Obiekt zawierający szczegóły harmonogramu odświeżania

ScheduleNotifyOption

Opcja powiadomienia po zakończeniu zaplanowanego odświeżania. Jednostki usługi obsługują NoNotification tylko wartość.

Nazwa	Typ	Opis
MailOnFailure	string	Powiadomienie e-mail zostanie wysłane po niepowodzeniu odświeżania
NoNotification	string	Żadne powiadomienie nie zostanie wysłane