Datasets - Refresh Dataset

Référence

Service:: Power BI REST APIs

Version d'API:: v1.0

Déclenche une actualisation du jeu de données spécifié à partir de Mon espace de travail. Une d’actualisation améliorée n’est déclenchée que si une charge utile de requête autre que notifyOption est définie.

Étendue requise

Dataset.ReadWrite.All

Limitations

Pour les capacités partagées, un maximum de huit requêtes par jour, y compris les actualisations exécutées à l’aide de l’actualisation planifiée, peuvent être lancées.
Pour les capacités partagées, seules les notifyOption peuvent être spécifiées dans le corps de la requête.
L’actualisation améliorée n’est pas prise en charge pour les capacités partagées.
Pour une actualisation améliorée, notifyOption n’est pas obligatoire et doit être exclu du corps de la requête. Toutefois, un ou plusieurs paramètres autres que notifyOption sont requis.
Pour les capacités Premium, les demandes maximales par jour sont limitées uniquement par les ressources disponibles dans la capacité. Si les ressources disponibles sont surchargées, les actualisations sont limitées jusqu’à ce que la charge soit réduite. L’actualisation échoue si la limitation dépasse 1 heure.

POST https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/refreshes

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
notifyOption	True	NotifyOption	Options de notification par courrier électronique. Ce paramètre n’est pas applicable aux actualisations améliorées ou aux opérations d’API avec un principal de service.
applyRefreshPolicy		boolean	Déterminer si la stratégie est appliquée ou non
commitMode		DatasetCommitMode	Détermine si les objets sont validés par lots ou uniquement une fois terminés
effectiveDate		string	Si une stratégie d’actualisation incrémentielle est appliquée, le paramètre `effectiveDate` remplace la date actuelle.
maxParallelism		integer	Nombre maximal de threads sur lesquels exécuter des commandes de traitement parallèle
objects		DatasetRefreshObjects[]	Tableau d’objets à traiter
retryCount		integer	Nombre de nouvelles tentatives avant l’échec de l’opération. Les erreurs internes temporaires peuvent déclencher une nouvelle tentative d’actualisation, même lorsque ce paramètre est défini sur 0.
type		DatasetRefreshType	Type de traitement à effectuer

Réponses

Nom	Type	Description
202 Accepted		Accepté En-têtes x-ms-request-id: string Location: string

Nom

Type

Description

202 Accepted

Accepté

En-têtes

x-ms-request-id: string
Location: string

Exemples

Example of refreshing a dataset

Example of refreshing one partition

Example of refreshing a dataset

Exemple de requête

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes

Exemple de réponse

Code d’état:: 202

x-ms-request-id: 03f22bb5-2e98-4ae8-8113-329bec3987b1
Location: https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes/03f22bb5-2e98-4ae8-8113-329bec3987b1

Example of refreshing one partition

Exemple de requête

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes

Corps de la demande

{
  "type": "full",
  "commitMode": "transactional",
  "objects": [
    {
      "table": "Customer",
      "partition": "Robert"
    }
  ],
  "applyRefreshPolicy": "false"
}

Exemple de réponse

Code d’état:: 200

Définitions

Nom	Description
DatasetCommitMode	Détermine si les objets sont validés par lots ou uniquement une fois terminés
DatasetRefreshObjects	Cible d’actualisation du jeu de données Power BI
DatasetRefreshRequest	Demande d’actualisation du jeu de données Power BI
DatasetRefreshType	Type de traitement à effectuer
NotifyOption	Options de notification par courrier électronique

DatasetCommitMode

Détermine si les objets sont validés par lots ou uniquement une fois terminés

Nom	Type	Description
PartialBatch	string	Validez l’opération d’actualisation par lots. Lorsque vous utilisez `partialBatch` mode, l’opération d’actualisation ne se produit pas dans une transaction. Par conséquent, chaque commande est validée individuellement et, en cas d’échec, le modèle peut se retrouver dans un état où seul un sous-ensemble des données est chargé, ou la table est laissée vide. Si vous souhaitez garantir la conservation des données précédentes en cas de défaillance, vous devez exécuter l’opération avec `commitMode = transactional.`
Transactional	string	Valider l’opération d’actualisation entière en tant que transaction

DatasetRefreshObjects

Cible d’actualisation du jeu de données Power BI

Nom	Type	Description
partition	string	Partition à actualiser
table	string	Tableau à actualiser

DatasetRefreshRequest

Demande d’actualisation du jeu de données Power BI

Nom	Type	Description
applyRefreshPolicy	boolean	Déterminer si la stratégie est appliquée ou non
commitMode	DatasetCommitMode	Détermine si les objets sont validés par lots ou uniquement une fois terminés
effectiveDate	string	Si une stratégie d’actualisation incrémentielle est appliquée, le paramètre `effectiveDate` remplace la date actuelle.
maxParallelism	integer	Nombre maximal de threads sur lesquels exécuter des commandes de traitement parallèle
notifyOption	NotifyOption	Options de notification par courrier électronique. Ce paramètre n’est pas applicable aux actualisations améliorées ou aux opérations d’API avec un principal de service.
objects	DatasetRefreshObjects[]	Tableau d’objets à traiter
retryCount	integer	Nombre de nouvelles tentatives avant l’échec de l’opération. Les erreurs internes temporaires peuvent déclencher une nouvelle tentative d’actualisation, même lorsque ce paramètre est défini sur 0.
type	DatasetRefreshType	Type de traitement à effectuer

DatasetRefreshType

Type de traitement à effectuer

Nom	Type	Description
Automatic	string	Si l’objet doit être actualisé et recalculé, actualisez et recalculez l’objet et tous ses dépendants. S’applique si la partition est dans un état autre que Ready.
Calculate	string	Recalculez cet objet et tous ses dépendants, mais uniquement si nécessaire. Cette valeur ne force pas le recalcul, à l’exception des formules volatiles.
ClearValues	string	Effacer les valeurs de cet objet et de tous ses dépendants
DataOnly	string	Actualiser les données dans cet objet et effacer tous les dépendants
Defragment	string	Défragmentez les données dans la table spécifiée. À mesure que les données sont ajoutées ou supprimées d’une table, les dictionnaires de chaque colonne peuvent devenir pollués par des valeurs qui n’existent plus dans les valeurs de colonne réelles. L’option de défragmentation nettoie les valeurs dans les dictionnaires qui ne sont plus utilisés.
Full	string	Pour toutes les partitions de la partition, de la table ou de la base de données spécifiées, actualisez les données et recalculez toutes les dépendances. Pour une partition de calcul, recalculez la partition et tous ses dépendants.

NotifyOption

Options de notification par courrier électronique

Nom	Type	Description
MailOnCompletion	string	Une notification par courrier indiquant la réussite ou l’échec sera envoyée lors de l’actualisation
MailOnFailure	string	Une notification par courrier électronique sera envoyée lors de l’échec de l’actualisation
NoNotification	string	Aucune notification n’est envoyée

Partager via

Datasets - Refresh Dataset

Étendue requise

Limitations

Paramètres URI

Corps de la demande

Réponses

Exemples

Example of refreshing a dataset

Exemple de requête

Exemple de réponse

Example of refreshing one partition

Exemple de requête

Exemple de réponse

Définitions

DatasetCommitMode

DatasetRefreshObjects

DatasetRefreshRequest

DatasetRefreshType

NotifyOption

Ressources supplémentaires