Partager via

Dataflows - Update Refresh Schedule

Service:
Power BI REST APIs
Version d'API:
v1.0

Crée ou met à jour la planification d’actualisation d’un flux de données spécifié.

Permissions

Cet appel d’API peut être appelé par un profil de principal de service. Pour plus d’informations, consultez : Profils de principal de service dans Power BI Embedded.

Étendue requise

Dataflow.ReadWrite.All 

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

Paramètres URI

Nom Dans Obligatoire Type Description
dataflowId
 path True

string (uuid)

ID de flux de données
groupId
 path True

string (uuid)

ID de l’espace de travail

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

Daily refresh schedule example
Disable refresh schedule example
Update refresh schedule times example

Daily refresh schedule example

Exemple de requête

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

Exemple de réponse

Code d’état:
200

Disable refresh schedule example

Exemple de requête

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

Exemple de réponse

Code d’état:
200

Update refresh schedule times example

Exemple de requête

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

Exemple de réponse

Code d’état:
200

Définitions

Nom Description
days

Jours sur lesquels exécuter l’actualisation
RefreshSchedule

Planification d’actualisation De 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

Énumération

Jours sur lesquels exécuter l’actualisation

Valeur Description
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

RefreshSchedule

Object

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

Nom Type Description
days

days[]

Jours sur lesquels exécuter l’actualisation
enabled

boolean

Indique si l’actualisation est activée
localTimeZoneId

string

ID du fuseau horaire à utiliser. Pour plus d’informations, consultez les informations du fuseau horaire.
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.
times

string[]

Heures de la journée d’exécution de l’actualisation

RefreshScheduleRequest

Object

Demande de planification d’actualisation Power BI

Nom Type Description
value

RefreshSchedule

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

ScheduleNotifyOption

Énumération

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

Valeur Description
NoNotification

Aucune notification n’est envoyée
MailOnFailure

Une notification par courrier électronique sera envoyée lors de l’échec de l’actualisation