Datasets - Update Refresh Schedule

Service:

Power BI REST APIs

API Version:

v1.0

Novedades la programación de actualización del conjunto de datos especificado de Mi área de trabajo.

Una solicitud que deshabilita la programación de actualización no debe contener ningún otro cambio.

Debe especificarse al menos un día. Si no se especifica ninguna hora, Power BI usará una única hora predeterminada al día.

Permisos

El usuario debe ser el propietario del conjunto de datos.

Ámbito requerido

Dataset.ReadWrite.All

Limitaciones

El límite del número de espacios de tiempo al día depende de si se usa una capacidad Premium o Compartida.

PATCH https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/refreshSchedule

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
datasetId	path	True	string	Identificador del conjunto de datos

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
value	True	RefreshSchedule	Objeto que contiene los detalles de una programación de actualización

Respuestas

Nombre	Tipo	Description
200 OK		Aceptar

Ejemplos

Change the days and times of a refresh schedule example

Change the notification option of a refresh schedule example

Disable a scheduled refresh example

Update the times of a refresh schedule example

Change the days and times of a refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule

Request Body

{
  "value": {
    "days": [
      "Sunday",
      "Tuesday",
      "Friday",
      "Saturday"
    ],
    "times": [
      "07:00",
      "11:30",
      "16:00",
      "23:30"
    ],
    "localTimeZoneId": "UTC"
  }
}

Sample Response

Status code:

200

Change the notification option of a refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule

Request Body

{
  "value": {
    "notifyOption": "NoNotification"
  }
}

Sample Response

Status code:

200

Disable a scheduled refresh example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule

Request Body

{
  "value": {
    "enabled": false
  }
}

Sample Response

Status code:

200

Update the times of a refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshSchedule

Request Body

{
  "value": {
    "times": [
      "08:00",
      "16:00"
    ]
  }
}

Sample Response

Status code:

200

Definiciones

Nombre	Description
days	Días en los que se va a ejecutar la actualización
RefreshSchedule	Una programación de actualización de Power BI para el modelo importado
RefreshScheduleRequest	Solicitud de programación de actualización de Power BI
ScheduleNotifyOption	La opción de notificación al finalizar una actualización programada. Las entidades de servicio solo admiten el NoNotification valor.

days

Días en los que se va a ejecutar la actualización

Nombre	Tipo	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

RefreshSchedule

Una programación de actualización de Power BI para el modelo importado

Nombre	Tipo	Description
NotifyOption	ScheduleNotifyOption	La opción de notificación al finalizar una actualización programada. Las entidades de servicio solo admiten el NoNotification valor.
days	days[]	Días en los que se va a ejecutar la actualización
enabled	boolean	Si la actualización está habilitada
localTimeZoneId	string	Identificador de la zona horaria que se va a usar. Para obtener más información, consulte Información de zona horaria.
times	string[]	Horas del día para ejecutar la actualización

RefreshScheduleRequest

Solicitud de programación de actualización de Power BI

Nombre	Tipo	Description
value	RefreshSchedule	Objeto que contiene los detalles de una programación de actualización

ScheduleNotifyOption

La opción de notificación al finalizar una actualización programada. Las entidades de servicio solo admiten el NoNotification valor.

Nombre	Tipo	Description
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