Dataflows - Update Refresh Schedule

  • 参考
Service:
Power BI REST APIs
API Version:
v1.0

创建或更新指定数据流的刷新计划。

权限

此 API 调用可由服务主体配置文件调用。 有关详细信息，请参阅：Power BI Embedded中的服务主体配置文件。

必需范围

Dataflow.ReadWrite.All

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

URI 参数

名称 在 必需 类型 说明
dataflowId
 path True

string

uuid

数据流 ID
groupId
 path True

string

uuid

工作区 ID

请求正文

名称 必需 类型 说明
value True

RefreshSchedule

包含刷新计划详细信息的 对象

响应

名称 类型 说明
200 OK

OK

示例

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

Daily refresh schedule example

Sample Request

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

Sample Response

Status code:
200

Disable refresh schedule example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataflows/928228ba-008d-4fd9-864a-92d2752ee5ce/refreshSchedule
Request Body
{
  "value": {
    "enabled": false
  }
}

Sample Response

Status code:
200

Update refresh schedule times example

Sample Request

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

Sample Response

Status code:
200

定义

名称 说明
days

执行刷新的日期
RefreshSchedule

导入模型的 Power BI 刷新计划
RefreshScheduleRequest

Power BI 刷新计划请求
ScheduleNotifyOption

计划刷新终止的通知选项。 服务主体仅支持 NoNotification 值。

days

执行刷新的日期

名称 类型 说明
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

RefreshSchedule

导入模型的 Power BI 刷新计划

名称 类型 说明
NotifyOption

ScheduleNotifyOption

计划刷新终止的通知选项。 服务主体仅支持 NoNotification 值。
days

days[]

执行刷新的日期
enabled

boolean

是否启用刷新
localTimeZoneId

string

要使用的时区的 ID。 有关详细信息，请参阅 时区信息。
times

string[]

执行刷新的一天中的时间

RefreshScheduleRequest

Power BI 刷新计划请求

名称 类型 说明
value

RefreshSchedule

包含刷新计划详细信息的 对象

ScheduleNotifyOption

计划刷新终止的通知选项。 服务主体仅支持 NoNotification 值。

名称 类型 说明
MailOnFailure

string

刷新失败时将发送邮件通知
NoNotification

string

不会发送通知