Datasets - Refresh Dataset

Attiva un aggiornamento per il set di dati specificato dall'area di lavoro personale. Viene attivato un aggiornamento avanzato solo se viene impostato un payload della richiesta diverso da notifyOption quello impostato.

Ambito obbligatorio

Dataset.ReadWrite.All

Limitazioni

  • Per le capacità condivise, è possibile avviare un massimo di otto richieste al giorno, inclusi gli aggiornamenti eseguiti tramite l'aggiornamento pianificato.
  • Per le capacità condivise, è possibile specificare solo notifyOption nel corpo della richiesta.
  • L'aggiornamento avanzato non è supportato per le capacità condivise.
  • Per l'aggiornamento avanzato, notifyOption non è necessario e deve essere escluso dal corpo della richiesta. Tuttavia, uno o più parametri diversi da notifyOption quelli necessari.
  • Per le capacità Premium, le richieste massime al giorno sono limitate solo dalle risorse disponibili nella capacità. Se le risorse disponibili vengono sovraccaricate, gli aggiornamenti vengono limitati fino a quando il carico non viene ridotto. L'aggiornamento avrà esito negativo se la limitazione supera 1 ora.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
datasetId
path True

string

ID del set di dati

Corpo della richiesta

Nome Necessario Tipo Descrizione
notifyOption True

NotifyOption

Opzioni di notifica di posta elettronica. Questo parametro non è applicabile alle operazioni di aggiornamento o API avanzate con un'entità servizio.

applyRefreshPolicy

boolean

Determinare se il criterio viene applicato o meno

commitMode

DatasetCommitMode

Determina se gli oggetti verranno sottoposti a commit in batch o solo al completamento

effectiveDate

string

Se viene applicato un criterio di aggiornamento incrementale, il parametro esegue l'override effectiveDate della data corrente.

maxParallelism

integer

Numero massimo di thread su cui eseguire comandi di elaborazione parallela

objects

DatasetRefreshObjects[]

Matrice di oggetti da elaborare

retryCount

integer

Numero di tentativi prima dell'esito negativo dell'operazione

type

DatasetRefreshType

Tipo di elaborazione da eseguire

Risposte

Nome Tipo Descrizione
202 Accepted

Accettato

Headers

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

Esempio

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

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
{
  "type": "full",
  "commitMode": "transactional",
  "objects": [
    {
      "table": "Customer",
      "partition": "Robert"
    }
  ],
  "applyRefreshPolicy": "false"
}

Sample Response

Definizioni

Nome Descrizione
DatasetCommitMode

Determina se gli oggetti verranno sottoposti a commit in batch o solo al completamento

DatasetRefreshObjects

Destinazione di aggiornamento del set di dati di Power BI

DatasetRefreshRequest

Richiesta di aggiornamento del set di dati di Power BI

DatasetRefreshType

Tipo di elaborazione da eseguire

NotifyOption

Opzioni di notifica di posta elettronica

DatasetCommitMode

Determina se gli oggetti verranno sottoposti a commit in batch o solo al completamento

Nome Tipo Descrizione
PartialBatch

string

Eseguire il commit dell'operazione di aggiornamento in batch. Quando si usa la modalità, l'operazione di partialBatch aggiornamento non si verifica all'interno di una transazione. Di conseguenza, ogni comando verrà eseguito il commit singolarmente e, in caso di errore, il modello potrebbe terminare in uno stato in cui viene caricato solo un subset dei dati oppure la tabella viene lasciata vuota. Se si desidera garantire la conservazione dei dati precedenti in caso di errore, è necessario eseguire l'operazione con commitMode = transactional.

Transactional

string

Eseguire il commit dell'intera operazione di aggiornamento come transazione

DatasetRefreshObjects

Destinazione di aggiornamento del set di dati di Power BI

Nome Tipo Descrizione
partition

string

Partizione da aggiornare

table

string

Tabella da aggiornare

DatasetRefreshRequest

Richiesta di aggiornamento del set di dati di Power BI

Nome Tipo Descrizione
applyRefreshPolicy

boolean

Determinare se il criterio viene applicato o meno

commitMode

DatasetCommitMode

Determina se gli oggetti verranno sottoposti a commit in batch o solo al completamento

effectiveDate

string

Se viene applicato un criterio di aggiornamento incrementale, il parametro esegue l'override effectiveDate della data corrente.

maxParallelism

integer

Numero massimo di thread su cui eseguire comandi di elaborazione parallela

notifyOption

NotifyOption

Opzioni di notifica di posta elettronica. Questo parametro non è applicabile alle operazioni di aggiornamento o API avanzate con un'entità servizio.

objects

DatasetRefreshObjects[]

Matrice di oggetti da elaborare

retryCount

integer

Numero di tentativi prima dell'esito negativo dell'operazione

type

DatasetRefreshType

Tipo di elaborazione da eseguire

DatasetRefreshType

Tipo di elaborazione da eseguire

Nome Tipo Descrizione
Automatic

string

Se l'oggetto deve essere aggiornato e ricalcolato, eseguire l'operazione richiesta sia per l'oggetto che per tutti i dipendenti. Si applica se la partizione è in uno stato diverso da pronta.

Calculate

string

Ricalcolare questo oggetto e tutti i relativi dipendenti, ma solo se necessario. Questo valore non forza la ricalcolazione, ad eccezione delle formule volatili.

ClearValues

string

Cancellare i valori in questo oggetto e tutti i relativi dipendenti

DataOnly

string

Aggiornare i dati in questo oggetto e cancellare tutti i dipendenti

Defragment

string

Deframmentare i dati nella tabella specificata. Man mano che vengono aggiunti o rimossi dati in una tabella, i dizionari di ogni colonna possono risultare contaminati da valori che non esistono più tra i valori di colonna effettivi. L'opzione defragment consentirà di pulire i valori non più usati nei dizionari.

Full

string

Per tutte le partizioni della partizione, della tabella o del database specificati, aggiornare i dati e ricalcolare tutti i dipendenti. Per una partizione di calcolo, ricalcolare la partizione e tutti i relativi dipendenti.

NotifyOption

Opzioni di notifica di posta elettronica

Nome Tipo Descrizione
MailOnCompletion

string

Una notifica di posta elettronica che indica l'esito positivo o negativo verrà inviato al completamento dell'aggiornamento

MailOnFailure

string

Una notifica di posta elettronica verrà inviata in caso di errore di aggiornamento

NoNotification

string

Nessuna notifica verrà inviata