Udostępnij przez

Dataflows - Update Refresh Schedule

Usługa:
Power BI REST APIs
Wersja interfejsu API:
v1.0

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

Permissions

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 usłudze 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200

Disable refresh schedule example

Przykładowe żądanie

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule
Treść żądania
{
  "value": {
    "enabled": false,
    "times": [],
    "localTimeZoneId": "UTC"
  }
}

Przykładowa odpowiedź

Kod stanu:
200

Update refresh schedule times example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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

Wyliczanie

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

Wartość Opis
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

RefreshSchedule

Objekt

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

Nazwa Typ Opis
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.
notifyOption

ScheduleNotifyOption

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

string[]

Czasy dnia do wykonania odświeżania

RefreshScheduleRequest

Objekt

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

Nazwa Typ Opis
value

RefreshSchedule

Obiekt zawierający szczegóły harmonogramu odświeżania

ScheduleNotifyOption

Wyliczanie

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

Wartość Opis
NoNotification

Powiadomienie nie zostanie wysłane
MailOnFailure

Powiadomienie e-mail zostanie wysłane po niepowodzeniu odświeżania