Partager via

Datasets - Update Refresh Schedule

  • Référence
Service:
Power BI REST APIs
API Version:
v1.0

Mises à jour la planification d’actualisation du jeu de données spécifié à partir de Mon espace de travail.

Une requête qui désactive la planification d’actualisation ne doit contenir aucune autre modification.

Au moins un jour doit être spécifié. Si aucune heure n’est spécifiée, Power BI utilise une seule heure par jour par défaut.

Autorisations

L’utilisateur doit être le propriétaire du jeu de données.

Étendue requise

Dataset.ReadWrite.All

Limites

La limite du nombre de créneaux horaires par jour dépend de l’utilisation d’une capacité Premium ou Partagée. 

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

Paramètres URI

Nom Dans Obligatoire Type Description
datasetId
 path True

string

ID du jeu de données

Corps de la demande

Nom Obligatoire Type Description
value True

RefreshSchedule

Objet qui contient les détails d’une planification d’actualisation

Réponses

Nom Type Description
200 OK

OK

Exemples

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

Définitions

Nom Description
days

Jours pendant lesquels exécuter l’actualisation
RefreshSchedule

Planification d’actualisation Power BI pour le modèle importé
RefreshScheduleRequest

Demande de planification d’actualisation Power BI
ScheduleNotifyOption

Option de notification lors de l’arrêt d’une actualisation planifiée. Les principaux de service prennent uniquement en charge la NoNotification valeur.

days

Jours pendant lesquels exécuter l’actualisation

Nom Type Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

RefreshSchedule

Planification d’actualisation Power BI pour le modèle importé

Nom Type Description
NotifyOption

ScheduleNotifyOption

Option de notification lors de l’arrêt d’une actualisation planifiée. Les principaux de service prennent uniquement en charge la NoNotification valeur.
days

days[]

Jours pendant lesquels exécuter l’actualisation
enabled

boolean

Si l’actualisation est activée
localTimeZoneId

string

ID du fuseau horaire à utiliser. Pour plus d’informations, consultez Informations de fuseau horaire.
times

string[]

Heures de la journée pour exécuter l’actualisation

RefreshScheduleRequest

Demande de planification d’actualisation Power BI

Nom Type Description
value

RefreshSchedule

Objet qui contient les détails d’une planification d’actualisation

ScheduleNotifyOption

Option de notification lors de l’arrêt d’une actualisation planifiée. Les principaux de service prennent uniquement en charge la NoNotification valeur.

Nom Type Description
MailOnFailure

string

Une notification par courrier électronique sera envoyée en cas d’échec d’actualisation
NoNotification

string

Aucune notification ne sera envoyée