Power BI Report Server 用の REST API を使用した開発

Power BI Report Server では、Representational State Transfer (REST) API がサポートされています。 REST API は、レポート サーバー内のリソースの作成、取得、更新、または削除アクセスを提供する一連の HTTP 操作 (メソッド) をサポートするサービス エンドポイントです。

REST API を使用すると、Power BI Report Server カタログ内のオブジェクトにプログラムでアクセスできます。 オブジェクトの例としては、フォルダー、レポート、KPI、データ ソース、データセット、更新プラン、サブスクリプションなどがあります。 REST API を使用すると、たとえば、フォルダー階層内を移動したり、フォルダーの内容を検出したり、レポート定義をダウンロードしたりできます。 オブジェクトを作成、更新、削除することもできます。 オブジェクトの操作の例としては、レポートのアップロード、更新計画の実行、フォルダーの削除などが挙けられます。

注

個人データの表示または削除については、「GDPR の Windows データ主体要求」サイトに方法が掲載されているのでそちらをご参照ください。 GDPR に関する一般的な情報をお探しの場合は、 Service Trust ポータルの GDPR セクションを参照してください。

REST API 要求/応答のコンポーネント

REST API の要求と応答のペアは、次の 5 つのコンポーネントに分けることができます。

• 要求 URI。次で構成されます: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}。 要求 URI は要求メッセージ ヘッダーに含まれていますが、ここでは個別に呼び出します。ほとんどの言語またはフレームワークでは、要求メッセージとは別に渡す必要があるためです。

  • URI スキーム: 要求の送信に使用されるプロトコルを示します。 たとえば、http または https です。
  • URI ホスト: REST サービス エンドポイントがホストされているサーバーのドメイン名または IP アドレス ( myserver.contoso.comなど) を指定します。
  • リソース パス: リソースまたはリソース コレクションを指定します。リソースの選択を決定するためにサービスによって使用される複数のセグメントを含めることができます。 たとえば、 CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties を使用して CatalogItem の指定したプロパティを取得できます。
  • クエリ文字列 (省略可能): API のバージョンやリソースの選択条件など、他の単純なパラメーターを提供します。

• HTTP 要求メッセージ ヘッダー フィールド:

  • 要求している操作の種類をサービスに通知する必要な HTTP メソッド (操作または動詞とも呼ばれます)。 Reporting Services REST API では、DELETE、GET、HEAD、PUT、POST、PATCH の各メソッドがサポートされます。
  • 指定された URI および HTTP メソッドで必要とされる、その他の省略可能なヘッダー フィールド。

• URI と HTTP 操作をサポートするためのオプションの HTTP 要求メッセージ本文 フィールド。 たとえば、POST 操作には、複雑なパラメーターとして渡される MIME でエンコードされたオブジェクトが含まれます。 POST または PUT 操作の場合は、本文の MIME エンコードの種類も Content-type 要求ヘッダーで指定する必要があります。 一部のサービスでは、 application/jsonなど、特定の MIME の種類を使用する必要があります。

• HTTP 応答メッセージのヘッダー フィールド:

  • 2xx 成功コードから 4xx または 5xx エラー コードまでの HTTP 状態コード。 または、API ドキュメントに示されているように、サービス定義の状態コードが返される場合があります。
  • 要求の応答をサポートするために必要なその他の省略可能なヘッダー フィールド ( Content-type 応答ヘッダーなど)。

• オプションの HTTP 応答メッセージ本文 フィールド:

  • MIME でエンコードされた応答オブジェクトは、データを返す GET メソッドからの応答など、HTTP 応答本文で返されます。 通常、これらのオブジェクトは、 Content-type 応答ヘッダーで示されているように、JSON や XML などの構造化形式で返されます。

API ドキュメント

モダンな REST API にはモダンな API ドキュメントが求められます。 REST API は OpenAPI 仕様 (swagger 仕様とも呼ばれます) に基づいて構築されており、 ドキュメントは Microsoft Learn で入手できます。

API 呼び出しのテスト

HTTP 要求/応答メッセージをテストするためのツールは Fiddler です。 Fiddler は、REST 要求をインターセプトできる無料の Web デバッグ プロキシであり、HTTP 要求/応答メッセージを簡単に診断できます。

関連コンテンツ

Microsoft Learn で使用可能な API を確認します。

サンプルは GitHub で入手できます。 このサンプルには、PowerShell の例と共に TypeScript、React、Webpack 上に構築された HTML5 アプリが含まれています。

他に質問はありますか？ Power BI コミュニティで質問してみてください。