Forum Discussion

learninggeek_01's avatar
learninggeek_01
Regular Visitor
11 months ago
Solved

Updating Schedule refresh for Power BI Report

Hi, As we know, Schedule refresh for Power BI report could be set manually on the UI. If we are trying to automate the setup of schedule refresh on a report instead of manually entering it, what ar...
@PowerBI Report Server
PowerBI REST API
  • v-achippa's avatar
    v-achippa
    11 months ago

    Hi learninggeek_01,

     

    Cache refresh plans apply only to Paginated reports, not to PBIX reports.
    For power bi(.pbix) reports use Refresh plans, which are managed separately through the Power BI Report Server REST API.

    For your reference below is the official documentation:

    https://learn.microsoft.com/en-us/power-bi/report-server/rest-api

     

    Below is a simple power shell code to create a refresh plan for a PBIX report using the REST API:

    $serverUrl = "https://<your-server>/reports/api/v2.0"
    $reportPath = "/Sales Reports/SalesPerformance"
    $report = Invoke-RestMethod -Uri "$serverUrl/CatalogItems?path=$([uri]::EscapeDataString($reportPath))" -UseDefaultCredentials
    $reportId = $report.value[0].Id

    $body = @{
    "@odata.type" = "#Model.RefreshPlan"
    "Name" = "Daily Refresh"
    "Enabled" = $true
    "StartDate" = (Get-Date "2025-10-14T02:00:00Z")
    "Recurrence" = @{
    "@odata.type" = "#Model.DailyRecurrence"
    "DaysInterval" = 1
    }
    } | ConvertTo-Json -Depth 10

    Invoke-RestMethod -Uri "$serverUrl/CatalogItems($reportId)/RefreshPlans" `
    -Method POST -ContentType "application/json" `
    -UseDefaultCredentials -Body $body

     

    Thanks and regards,

    Anjan Kumar Chippa

learninggeek_01's avatar
learninggeek_01
Regular Visitor
11 months ago

Thank you for the response! 

Does REST API for writing schedules only work on Power BI cloud? 

Ex: This shows that subscriptions are only supported for paginated reportshttps://learn.microsoft.com/en-us/power-bi/report-server/compare-report-server-service

Compare Power BI Report Server and the Power BI service - Power BI | Microsoft Learn

This article compares the features of Power BI Report Server and the Power BI service.

 the cloud version can do both, not on prem.

 

If it works with On Prem, Can you point me to sample code where the REST API can write schedule informtion to a Power BI report on report server. 

 

v-achippa's avatar
v-achippa
Icon for Community Support rankCommunity Support
11 months ago

Hi learninggeek_01,

 

Yes, the Power BI Report Server REST API works on-premises and can create, update and delete refresh schedules for PBIX reports hosted on an on-prem Report Server. It does not depend on Power BI Service or the cloud.

Here the confusion in the comparison article is because the subscriptions are indeed only for paginated reports, but PBIX refresh plans are managed separately through the REST API, not through subscriptions.

Please refer to the below official documentation here:

https://learn.microsoft.com/en-us/power-bi/report-server/rest-api

 

Thanks and regards,

Anjan Kumar Chippa

  • learninggeek_01's avatar
    learninggeek_01
    Regular Visitor
    11 months ago

    Thank you!

    Will you over the reference link.

    How about Cache refresh plans. Are they for Paginated reports or Power B Ireports?

    Any sample power shell code that access RESP API for craeting schedules that I can access?

     

    • v-achippa's avatar
      v-achippa
      Icon for Community Support rankCommunity Support
      11 months ago

      Hi learninggeek_01,

       

      Cache refresh plans apply only to Paginated reports, not to PBIX reports.
      For power bi(.pbix) reports use Refresh plans, which are managed separately through the Power BI Report Server REST API.

      For your reference below is the official documentation:

      https://learn.microsoft.com/en-us/power-bi/report-server/rest-api

       

      Below is a simple power shell code to create a refresh plan for a PBIX report using the REST API:

      $serverUrl = "https://<your-server>/reports/api/v2.0"
      $reportPath = "/Sales Reports/SalesPerformance"
      $report = Invoke-RestMethod -Uri "$serverUrl/CatalogItems?path=$([uri]::EscapeDataString($reportPath))" -UseDefaultCredentials
      $reportId = $report.value[0].Id

      $body = @{
      "@odata.type" = "#Model.RefreshPlan"
      "Name" = "Daily Refresh"
      "Enabled" = $true
      "StartDate" = (Get-Date "2025-10-14T02:00:00Z")
      "Recurrence" = @{
      "@odata.type" = "#Model.DailyRecurrence"
      "DaysInterval" = 1
      }
      } | ConvertTo-Json -Depth 10

      Invoke-RestMethod -Uri "$serverUrl/CatalogItems($reportId)/RefreshPlans" `
      -Method POST -ContentType "application/json" `
      -UseDefaultCredentials -Body $body

       

      Thanks and regards,

      Anjan Kumar Chippa

      • v-achippa's avatar
        v-achippa
        Icon for Community Support rankCommunity Support
        10 months ago

        Hi learninggeek_01,

         

        As we haven’t heard back from you, we wanted to kindly follow up to check if the solution I have provided for the issue worked? or let us know if you need any further assistance.

         

        Thanks and regards,

        Anjan Kumar Chippa