Datasets - Refresh Dataset In Group
Déclenche une actualisation du jeu de données spécifié à partir de l’espace de travail spécifié. Une actualisation améliorée est déclenchée uniquement si une charge utile de requête autre que notifyOption
est définie.
Autorisations
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
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, peuvent être lancées.
- Pour les capacités partagées, seules
notifyOption
peuvent être spécifiées dans le corps de la demande. - L’actualisation améliorée n’est pas prise en charge pour les capacités partagées.
- Pour l’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 quenotifyOption
sont 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/groups/{groupId}/datasets/{datasetId}/refreshes
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
dataset
|
path | True |
string |
ID du jeu de données |
group
|
path | True |
string uuid |
L’ID de l’espace de travail |
Corps de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
notifyOption | True |
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 |
Détermine si les objets seront commité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 |
|
maxParallelism |
integer |
Nombre maximal de threads sur lesquels exécuter des commandes de traitement parallèle |
|
objects |
Tableau d’objets à traiter |
||
retryCount |
integer |
Nombre de tentatives de l’opération avant l’échec |
|
type |
Type de traitement à effectuer |
Réponses
Nom | Type | Description |
---|---|---|
202 Accepted |
Accepté Headers
|
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/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
{
"notifyOption": "MailOnFailure",
"retryCount": 3
}
Sample Response
x-ms-request-id: 87f31ef7-1e3a-4006-9b0b-191693e79e9e
Location: https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes/87f31ef7-1e3a-4006-9b0b-191693e79e9e
Example of refreshing one partition
Sample Request
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
{
"type": "full",
"commitMode": "transactional",
"objects": [
{
"table": "Customer",
"partition": "Robert"
}
],
"applyRefreshPolicy": "false"
}
Sample Response
Définitions
Nom | Description |
---|---|
Dataset |
Détermine si les objets seront commités par lots ou uniquement une fois terminés |
Dataset |
Cible d’actualisation du jeu de données Power BI |
Dataset |
Demande d’actualisation du jeu de données Power BI |
Dataset |
Type de traitement à effectuer |
Notify |
Options de notification par courrier électronique |
DatasetCommitMode
Détermine si les objets seront commités par lots ou uniquement une fois terminés
Nom | Type | Description |
---|---|---|
PartialBatch |
string |
Validez l’opération d’actualisation par lots. Lors de l’utilisation du |
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 |
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 |
Détermine si les objets seront commité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 |
maxParallelism |
integer |
Nombre maximal de threads sur lesquels exécuter des commandes de traitement parallèle |
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 |
Tableau d’objets à traiter |
|
retryCount |
integer |
Nombre de tentatives de l’opération avant l’échec |
type |
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 toutes ses dépendances |
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 e-mail indiquant la réussite ou l’échec est envoyée à la fin de l’actualisation |
MailOnFailure |
string |
Une notification par e-mail est envoyée en cas d’échec d’actualisation |
NoNotification |
string |
Aucune notification ne sera envoyée |