Compartir a través de

Dataflows - Update Refresh Schedule

Servicio:
Power BI REST APIs
Versión de la API:
v1.0

Crea o actualiza la programación de actualización de un flujo de datos especificado.

Permissions

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

Dataflow.ReadWrite.All 

PATCH https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows/{dataflowId}/refreshSchedule

Parámetros de identificador URI

Nombre En Requerido Tipo Description
dataflowId
 path True

string (uuid)

Identificador del flujo de datos
groupId
 path True

string (uuid)

Identificador del área de trabajo

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

OK

Ejemplos

Daily refresh schedule example
Disable refresh schedule example
Update refresh schedule times example

Daily refresh schedule example

Solicitud de ejemplo

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule
Cuerpo de la solicitud
{
  "value": {
    "days": [
      "Sunday",
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday"
    ],
    "times": [
      "10:00",
      "16:00"
    ],
    "enabled": true,
    "localTimeZoneId": "UTC",
    "notifyOption": "NoNotification"
  }
}

Respuesta de muestra

status code:
200

Disable refresh schedule example

Solicitud de ejemplo

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule
Cuerpo de la solicitud
{
  "value": {
    "enabled": false,
    "times": [],
    "localTimeZoneId": "UTC"
  }
}

Respuesta de muestra

status code:
200

Update refresh schedule times example

Solicitud de ejemplo

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule
Cuerpo de la solicitud
{
  "value": {
    "times": [
      "10:30",
      "16:30"
    ],
    "enabled": true,
    "localTimeZoneId": "UTC"
  }
}

Respuesta de muestra

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

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

days

Enumeración

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

Valor Description
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

RefreshSchedule

Object

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

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

ScheduleNotifyOption

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

string[]

Horas del día para ejecutar la actualización

RefreshScheduleRequest

Object

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

Enumeración

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

Valor Description
NoNotification

No se enviará ninguna notificación
MailOnFailure

Se enviará una notificación de correo en caso de error de actualización.