Datasets - Refresh Dataset

Référence

Service:: Power BI REST APIs

API Version:: v1.0

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

Étendue requise

Dataset.ReadWrite.All

Limites

Pour les capacités partagées, un maximum de huit demandes par jour, y compris les actualisations exécutées à l’aide de l’actualisation planifiée, peut être lancé.
Pour les capacités partagées, seules 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 demande. Toutefois, un ou plusieurs paramètres autres que notifyOption ceux requis.
Pour les capacités Premium, le nombre maximal de demandes par jour est limité 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 ne s’applique pas 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 seront validées par lots ou uniquement lorsqu’ils sont 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èles
objects		DatasetRefreshObjects[]	Tableau d’objets à traiter
retryCount		integer	Nombre de nouvelles tentatives de l’opération avant d’échouer
type		DatasetRefreshType	Type de traitement à effectuer

Réponses

Nom	Type	Description
202 Accepted		Accepté Headers x-ms-request-id: string Location: string

Nom

Type

Description

202 Accepted

Accepté

Headers

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

Exemples

Example of refreshing a dataset

Example of refreshing one partition

Example of refreshing a dataset

Sample Request

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

Sample Response

Status code:: 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

Sample Request

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

Request Body

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

Sample Response

Status code:: 200

Définitions

Nom	Description
DatasetCommitMode	Détermine si les objets seront validées par lots ou uniquement lorsqu’ils sont 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 seront validées par lots ou uniquement lorsqu’ils sont terminés

Nom	Type	Description
PartialBatch	string	Commitez l’opération d’actualisation par lots. Lors de l’utilisation du `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 de défaillance, 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’ensemble de l’opération d’actualisation en tant que transaction

DatasetRefreshObjects

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

Nom	Type	Description
partition	string	Partition à actualiser
table	string	Table à 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 seront validées par lots ou uniquement lorsqu’ils sont 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èles
notifyOption	NotifyOption	Options de notification par courrier électronique. Ce paramètre ne s’applique pas 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 de l’opération avant d’échouer
type	DatasetRefreshType	Type de traitement à effectuer

DatasetRefreshType

Type de traitement à effectuer

Nom	Type	Description
Automatic	string	Si l’objet doit être actualisé et recalculé, actualiser et recalculer l’objet et tous ses éléments dépendants. S’applique si la partition est dans un état autre que Prêt.
Calculate	string	Recalculer cet objet et tous ses éléments dépendants, mais seulement si nécessaire. Cette valeur ne force pas le recalcul, sauf pour les formules volatiles.
ClearValues	string	Effacer les valeurs de cet objet et de tous ses dépendants
DataOnly	string	Actualiser les données de cet objet et effacer toutes les dépendances
Defragment	string	Défragmenter les données dans la table spécifiée. Comme 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 actuelles des colonnes. L’option de défragmentation nettoie les valeurs dans les dictionnaires qui ne sont plus utilisées.
Full	string	Pour toutes les partitions dans la partition, la table ou la base de données spécifiée, actualiser les données et recalculer toutes les éléments dépendants. Pour une partition de calcul, recalculer la partition et tous ses éléments 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 à la fin de l’actualisation
MailOnFailure	string	Une notification par courrier électronique sera envoyée en cas d’échec d’actualisation
NoNotification	string	Aucune notification ne sera envoyée

Datasets - Refresh Dataset

Étendue requise

Limites

Paramètres URI

Corps de la demande

Réponses

Exemples

Example of refreshing a dataset

Sample Request

Sample Response

Example of refreshing one partition

Sample Request

Sample Response

Définitions

DatasetCommitMode

DatasetRefreshObjects

DatasetRefreshRequest

DatasetRefreshType

NotifyOption

Ressources supplémentaires