使用 Power BI Report Server 的 REST API 進行開發

Power BI 報表伺服器支援表示狀態傳輸（REST）API。 REST API 是支援一組 HTTP 操作（方法）的服務端點，提供報告伺服器內資源的建立、檢索、更新或刪除存取權。

REST API 提供對 Power BI 報表伺服器目錄中物件的程式存取。 物件的例子包括資料夾、報告、KPI、資料來源、資料集、刷新計畫、訂閱等。 利用 REST API，你可以瀏覽資料夾階層、發現資料夾內容，或下載報表定義。 你也可以建立、更新和刪除物件。 處理物件的例子包括上傳報告、執行刷新計畫、刪除資料夾等等。

備註

如果您想要檢視或刪除個人資料，請檢閱 Microsoft 在適用於 GDPR 的 Windows 資料主體要求網站中的指引。 如果您要尋找 GDPR 的一般資訊，請參閱 服務信任入口網站的 GDPR 一節。

REST API 請求/回應的組成部分

REST API 請求/回應對可分為五個組成部分：

• 請求 URI，包含： {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}。 雖然請求 URI 包含在請求訊息標頭中，但我們在此特別說明，因為大多數語言或框架要求你將 URI 與請求訊息分開傳遞。

  • URI 方案：表示用於傳送請求的協定。 例如，http 或 https。
  • URI 主機：指定 REST 服務端點所託管伺服器的網域名稱或 IP 位址，例如 myserver.contoso.com。
  • 資源路徑：指定資源或資源集合，可能包含服務在決定這些資源選擇時使用的多個區段。 例如： CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties 可以用來取得 CatalogItem 指定的屬性。
  • 查詢字串（可選）：提供其他簡單參數，如 API 版本或資源選擇條件。

• HTTP 請求訊息標頭欄位：

  • 一個必須的 HTTP 方法 （也稱為操作或動詞），用來告訴服務你正在請求哪種類型的操作。 報表服務 REST API 支援 DELETE、GET、HEAD、PUT、POST 及 PATCH 方法。
  • 其他可選的標頭欄位，依據指定的 URI 與 HTTP 方法所要求。

• 可選的 HTTP 請求訊息主體 欄位，以支援 URI 與 HTTP 操作。 例如，POST 操作包含以複雜參數傳遞的 MIME 編碼物件。 對於 POST 或 PUT 操作，請求標頭中也應指定 Content-type 主體的 MIME 編碼類型。 有些服務要求你使用特定的 MIME 類型，例如 application/json。

• HTTP 回應訊息標頭 欄位：

  • HTTP 狀態碼，範圍從 2xx 成功碼到 4xx 或 5xx 錯誤碼不等。 或者，也可以回傳服務定義的狀態碼，如 API 文件中所述。
  • 其他如回應標頭等可選擇的標頭欄位，依支援請求回應的必要條件而定，例如 Content-type。

• 可選的 HTTP 回應訊息主體 欄位：

  • MIME 編碼的回應物件會在 HTTP 回應實體中回傳，例如來自 GET 方法回傳資料的回應。 通常，這些物件會以結構化格式回傳，如 JSON 或 XML，並由回應標頭指示 Content-type 。

API 文件

現代的 REST API 需要現代的 API 文件。 REST API 是建立在 OpenAPI 規範（亦稱為 swagger 規範）之上，相關文件可在 Microsoft Learn 上取得。

測試 API 呼叫

測試 HTTP 請求/回應訊息的工具是 Fiddler。 Fiddler 是一個免費的網頁除錯代理，可以攔截你的 REST 請求，讓你輕鬆診斷 HTTP 請求/回應訊息。

相關內容

請參考 Microsoft Learn 上可用的 API。

範例可在 GitHub 上取得。 範例包含一個基於 TypeScript、React 和 webpack 建置的 HTML5 應用程式，以及一個 PowerShell 範例。

其他問題嗎？ 試著向 Power BI 社群提問