Datasets - Refresh Dataset In Group

Referencia

Service:: Power BI REST APIs

API Version:: v1.0

Desencadena una actualización para el conjunto de datos especificado desde el área de trabajo especificada. Una actualización mejorada solo se desencadena si se establece una carga de solicitud distinta notifyOption de la establecida.

Permisos

Un perfil de entidad de servicio puede llamar a esta llamada API. Para obtener más información, consulte: Perfiles de entidad de servicio en Power BI Embedded.

Ámbito requerido

Dataset.ReadWrite.All

Limitaciones

En el caso de las capacidades compartidas, se puede iniciar un máximo de ocho solicitudes al día, incluidas las actualizaciones ejecutadas mediante la actualización programada.
En el caso de las capacidades compartidas, solo notifyOption se puede especificar en el cuerpo de la solicitud.
No se admite la actualización mejorada para las capacidades compartidas.
Para la actualización mejorada, notifyOption no es necesario y debe excluirse del cuerpo de la solicitud. Sin embargo, se requieren uno o varios parámetros distintos notifyOption de los necesarios.
En el caso de las capacidades Premium, las solicitudes máximas por día solo están limitadas por los recursos disponibles en la capacidad. Si se sobrecargan los recursos disponibles, las actualizaciones se limitan hasta que se reduce la carga. Se producirá un error en la actualización si la limitación supera las 1 hora.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
datasetId	path	True	string	Identificador del conjunto de datos
groupId	path	True	string uuid	Identificador del área de trabajo

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
notifyOption	True	NotifyOption	Opciones de notificación de correo electrónico. Este parámetro no es aplicable a las actualizaciones mejoradas ni a las operaciones de API con una entidad de servicio.
applyRefreshPolicy		boolean	Determinar si la directiva se aplica o no
commitMode		DatasetCommitMode	Determina si los objetos se confirmarán en lotes o solo cuando se completen
effectiveDate		string	Si se aplica una directiva de actualización incremental, el parámetro `effectiveDate` invalidará la fecha actual.
maxParallelism		integer	Número máximo de subprocesos en los que ejecutar comandos de procesamiento paralelo
objects		DatasetRefreshObjects[]	Matriz de objetos que se van a procesar
retryCount		integer	Número de veces que la operación se reintentará antes de que se produzca un error
type		DatasetRefreshType	Tipo de procesamiento que se va a realizar

Respuestas

Nombre	Tipo	Description
202 Accepted		Aceptado Headers x-ms-request-id: string Location: string

Nombre

Tipo

Description

202 Accepted

Aceptado

Headers

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

Ejemplos

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

Request Body

{
  "notifyOption": "MailOnFailure",
  "retryCount": 3
}

Sample Response

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

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/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

Definiciones

Nombre	Description
DatasetCommitMode	Determina si los objetos se confirmarán en lotes o solo cuando se completen
DatasetRefreshObjects	Destino de actualización del conjunto de datos de Power BI
DatasetRefreshRequest	Solicitud de actualización del conjunto de datos de Power BI
DatasetRefreshType	Tipo de procesamiento que se va a realizar
NotifyOption	Opciones de notificación de correo

DatasetCommitMode

Determina si los objetos se confirmarán en lotes o solo cuando se completen

Nombre	Tipo	Description
PartialBatch	string	Confirme la operación de actualización en lotes. Al usar el `partialBatch` modo , la operación de actualización no se produce dentro de una transacción. Por lo tanto, cada comando se confirmará individualmente y, en caso de error, el modelo puede acabar en un estado en el que solo se carga un subconjunto de los datos o la tabla se deja vacía. Si desea garantizar la conservación de datos anteriores en caso de error, debe ejecutar la operación con `commitMode = transactional.`
Transactional	string	Confirmar toda la operación de actualización como una transacción

DatasetRefreshObjects

Destino de actualización del conjunto de datos de Power BI

Nombre	Tipo	Description
partition	string	Partición para actualizar
table	string	Tabla que se va a actualizar

DatasetRefreshRequest

Solicitud de actualización del conjunto de datos de Power BI

Nombre	Tipo	Description
applyRefreshPolicy	boolean	Determinar si la directiva se aplica o no
commitMode	DatasetCommitMode	Determina si los objetos se confirmarán en lotes o solo cuando se completen
effectiveDate	string	Si se aplica una directiva de actualización incremental, el parámetro `effectiveDate` invalidará la fecha actual.
maxParallelism	integer	Número máximo de subprocesos en los que ejecutar comandos de procesamiento paralelo
notifyOption	NotifyOption	Opciones de notificación de correo electrónico. Este parámetro no es aplicable a las actualizaciones mejoradas ni a las operaciones de API con una entidad de servicio.
objects	DatasetRefreshObjects[]	Matriz de objetos que se van a procesar
retryCount	integer	Número de veces que la operación se reintentará antes de que se produzca un error
type	DatasetRefreshType	Tipo de procesamiento que se va a realizar

DatasetRefreshType

Tipo de procesamiento que se va a realizar

Nombre	Tipo	Description
Automatic	string	Si el objeto se debe actualizar, actualice el objeto y todos sus elementos dependientes. Se aplica si la partición se encuentra en un estado que no sea Ready.
Calculate	string	Actualice este objeto y todos sus elementos dependientes, pero solo si es necesario. Este valor no fuerza la actualización, excepto las fórmulas volátiles.
ClearValues	string	Borrar valores en este objeto y todos sus dependientes
DataOnly	string	Actualizar los datos de este objeto y borrar todos los dependientes
Defragment	string	Desfragmente los datos de la tabla especificada. Ya que los datos se agregan a una tabla o se quitan de ella, los diccionarios de cada columna pueden contaminarse con valores que ya no existen en los valores de columna reales. La opción de desfragmentar limpiará los valores de los diccionarios que ya no se usan.
Full	string	Para todas las particiones en la partición, tabla o base de datos especificada, actualice los datos y actualice todos los elementos dependientes. Para una partición de cálculo, actualice la partición y todos sus elementos dependientes.

NotifyOption

Opciones de notificación de correo

Nombre	Tipo	Description
MailOnCompletion	string	Se enviará una notificación de correo electrónico que indica que se ha realizado correctamente o se producirá un error al finalizar la actualización.
MailOnFailure	string	Se enviará una notificación por correo cuando se produzca un error de actualización.
NoNotification	string	No se enviará ninguna notificación

Datasets - Refresh Dataset In Group

Permisos

Ámbito requerido

Limitaciones

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Example of refreshing a dataset

Sample Request

Sample Response

Example of refreshing one partition

Sample Request

Sample Response

Definiciones

DatasetCommitMode

DatasetRefreshObjects

DatasetRefreshRequest

DatasetRefreshType

NotifyOption

Recursos adicionales