Datasets - Refresh Dataset

  • Referência
Service:
Power BI REST APIs
API Version:
v1.0

Dispara uma atualização para o conjunto de dados especificado de Meu workspace. Uma atualização aprimorada será disparada somente se uma carga de solicitação diferente de notifyOption estiver definida.

Escopo necessário

Dataset.ReadWrite.All

Limitações

  • Para capacidades compartilhadas, é possível iniciar no máximo oito solicitações por dia, incluindo atualizações executadas usando a atualização agendada.
  • Para capacidades compartilhadas, só notifyOption pode ser especificado no corpo da solicitação.
  • Não há suporte para atualização aprimorada para capacidades compartilhadas.
  • Para atualização aprimorada, notifyOption não é necessário e deve ser excluído do corpo da solicitação. No entanto, um ou mais parâmetros diferentes de notifyOption são necessários.
  • Para capacidades Premium, o máximo de solicitações por dia é limitado apenas pelos recursos disponíveis na capacidade. Se os recursos disponíveis estiverem sobrecarregados, as atualizações serão limitadas até que a carga seja reduzida. A atualização falhará se a limitação exceder 1 hora. 

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
datasetId
 path True

string

A ID do conjunto de dados

Corpo da solicitação

Nome Obrigatório Tipo Description
notifyOption True

NotifyOption

Opções de notificação por email. Esse parâmetro não é aplicável a atualizações aprimoradas ou operações de API com uma entidade de serviço.
applyRefreshPolicy

boolean

Determinar se a política é aplicada ou não
commitMode

DatasetCommitMode

Determina se os objetos serão confirmados em lotes ou somente quando concluídos
effectiveDate

string

Se uma política de atualização incremental for aplicada, o parâmetro effectiveDate substituirá a data atual.
maxParallelism

integer

O número máximo de threads nos quais executar comandos de processamento paralelo
objects

DatasetRefreshObjects[]

Uma matriz de objetos a serem processados
retryCount

integer

Número de vezes que a operação tentará novamente antes de falhar
type

DatasetRefreshType

O tipo de processamento a ser executado

Respostas

Nome Tipo Description
202 Accepted

Aceito

Headers

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

Exemplos

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

Definições

Nome Description
DatasetCommitMode

Determina se os objetos serão confirmados em lotes ou somente quando concluídos
DatasetRefreshObjects

Destino de atualização do conjunto de dados do Power BI
DatasetRefreshRequest

Solicitação de atualização do conjunto de dados do Power BI
DatasetRefreshType

O tipo de processamento a ser executado
NotifyOption

Opções de notificação por email

DatasetCommitMode

Determina se os objetos serão confirmados em lotes ou somente quando concluídos

Nome Tipo Description
PartialBatch

string

Confirme a operação de atualização em lotes. Ao utilizar o partialBatch modo, a operação de atualização não ocorre dentro de uma transação. Consequentemente, cada comando será confirmado individualmente e, em caso de falha, o modelo pode acabar em um estado em que apenas um subconjunto dos dados é carregado ou a tabela fica vazia. Se você quiser garantir a preservação de dados anteriores em caso de falha, execute a operação com commitMode = transactional.
Transactional

string

Confirmar toda a operação de atualização como uma transação

DatasetRefreshObjects

Destino de atualização do conjunto de dados do Power BI

Nome Tipo Description
partition

string

Partição a ser atualizada
table

string

Tabela a ser atualizada

DatasetRefreshRequest

Solicitação de atualização do conjunto de dados do Power BI

Nome Tipo Description
applyRefreshPolicy

boolean

Determinar se a política é aplicada ou não
commitMode

DatasetCommitMode

Determina se os objetos serão confirmados em lotes ou somente quando concluídos
effectiveDate

string

Se uma política de atualização incremental for aplicada, o parâmetro effectiveDate substituirá a data atual.
maxParallelism

integer

O número máximo de threads nos quais executar comandos de processamento paralelo
notifyOption

NotifyOption

Opções de notificação por email. Esse parâmetro não é aplicável a atualizações aprimoradas ou operações de API com uma entidade de serviço.
objects

DatasetRefreshObjects[]

Uma matriz de objetos a serem processados
retryCount

integer

Número de vezes que a operação tentará novamente antes de falhar
type

DatasetRefreshType

O tipo de processamento a ser executado

DatasetRefreshType

O tipo de processamento a ser executado

Nome Tipo Description
Automatic

string

Se o objeto precisar ser atualizado e recalculado, atualize e recalcule o objeto e todos os seus dependentes. Será aplicado se a partição estiver em um estado diferente de Ready.
Calculate

string

Recalcule este objeto e todos os seus dependentes, mas somente se necessário. Esse valor não força o recálculo, exceto fórmulas voláteis.
ClearValues

string

Limpar valores neste objeto e todos os seus dependentes
DataOnly

string

Atualizar dados neste objeto e limpar todos os dependentes
Defragment

string

Desfragmente os dados na tabela especificada. Como os dados são adicionados ou removidos de uma tabela, os dicionários de cada coluna podem ficar poluídos com valores que não existem mais nos valores de coluna reais. A opção de desfragmentar limpará os valores nos dicionários que não são mais usados.
Full

string

Para todas as partições na partição, tabela ou banco de dados especificado, atualize os dados e recalcule todos os dependentes. Para uma partição de cálculo, recalcule a partição e todos os seus dependentes.

NotifyOption

Opções de notificação por email

Nome Tipo Description
MailOnCompletion

string

Uma notificação por email indicando êxito ou falha será enviada na conclusão da atualização
MailOnFailure

string

Uma notificação por email será enviada em caso de falha na atualização
NoNotification

string

Nenhuma notificação será enviada