Datasets - Refresh Dataset In Group

  • Referência
Serviço:
Power BI REST APIs
Versão da API:
v1.0

Dispara uma atualização para o conjunto de dados especificado do workspace especificado. Uma de atualização aprimorada será disparada somente se um conteúdo de solicitação diferente de estiver definido.

Permissões

Essa chamada à API pode ser chamada por um perfil de entidade de serviço. Para obter mais informações, consulte: Perfis de entidade de serviço no Power BI Embedded.

Escopo necessário

Dataset.ReadWrite.All

Limitações

  • Para capacidades compartilhadas, no máximo oito solicitações por dia, incluindo atualizações executadas usando a atualização agendada, podem ser iniciadas.
  • Para capacidades compartilhadas, somente 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/groups/{groupId}/datasets/{datasetId}/refreshes

Parâmetros de URI

Nome Em Obrigatório Tipo Description
datasetId
 path True

string

A ID do conjunto de dados
groupId
 path True

string

uuid

A ID do workspace

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. Erros internos temporários podem disparar uma repetição da atualização, mesmo quando esse parâmetro é definido como 0.
type

DatasetRefreshType

O tipo de processamento a ser executado

Respostas

Nome Tipo Description
202 Accepted

Aceitado

Cabeçalhos

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

Exemplos

Example of refreshing a dataset
Example of refreshing one partition

Example of refreshing a dataset

Solicitação de exemplo

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
Corpo da solicitação
{
  "notifyOption": "MailOnFailure",
  "retryCount": 3
}

Resposta de exemplo

Código de status:
202 
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

Solicitação de exemplo

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes
Corpo da solicitação
{
  "type": "full",
  "commitMode": "transactional",
  "objects": [
    {
      "table": "Customer",
      "partition": "Robert"
    }
  ],
  "applyRefreshPolicy": "false"
}

Resposta de exemplo

Código de status:
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 partialBatch modo, a operação de atualização não ocorre dentro de uma transação. Consequentemente, cada comando será confirmado individualmente e, no caso de uma falha, o modelo pode acabar em um estado em que apenas um subconjunto dos dados é carregado ou a tabela é deixada vazia. Se desejar 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. Erros internos temporários podem disparar uma repetição da atualização, mesmo quando esse parâmetro é definido como 0.
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. Aplica-se se a partição estiver em um estado diferente de Pronto.
Calculate

string

Recalcule esse 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

Desfragmentar os dados na tabela especificada. À medida que 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 reais da coluna. A opção de desfragmentação 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 especificados, 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 de email que indica êxito ou falha será enviada na conclusão da atualização
MailOnFailure

string

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

string

Nenhuma notificação será enviada