Reporting Services の REST API による開発

[アーティクル]
12/21/2023

適用対象: SQL Server Reporting Services (2017 以降) ❌ Power BI Report Server

Microsoft SQL Server 2017 Reporting Services では、Representational State Transfer (REST) API がサポートされます。 REST API は、一連の HTTP 操作 (メソッド) をサポートするサービスエンドポイントであり、レポートサーバー内のリソースに対する作成、取得、更新、削除アクセスを提供します。

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

Note

個人データの表示または削除については、GDPR の Windows データ主体要求に関するページで Microsoft のガイダンスをご確認ください。 GDPR に関する一般的な情報については、Service Trust Portal の GDPR セクションを参照してください。

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

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

要求 URI。{URI-scheme} :// {URI-host} / {resource-path} ? {query-string} で構成されます。要求 URI は要求メッセージヘッダーに含まれていますが、ほとんどの言語やフレームワークでは要求メッセージとは別に渡す必要があるため、ここでは独立した項目にしてあります。
- URI スキーム: 要求の送信に使用されるプロトコルを示します。たとえば、http または https です。
- URI ホスト: myserver.contoso.com など、REST サービスエンドポイントがホストされているサーバーのドメイン名または IP アドレスを指定します。
- リソースパス: リソースまたはリソースコレクションを指定します。リソースの選択を決定するときにサービスによって使用される複数のセグメントを含むことができます。たとえば、CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties を使用して、CatalogItem の指定したプロパティを取得できます。
- クエリ文字列 (省略可能): API のバージョンやリソースの選択条件など、より簡単なパラメーターを提供します。
HTTP 要求メッセージヘッダーフィールド:
- 要求している操作の種類をサービスに伝える、必要な HTTP メソッド (操作または動詞とも呼ばれます)。 Reporting Services REST API では、DELETE、GET、HEAD、PUT、POST、および PATCH の各メソッドがサポートされます。
- 指定された URI および HTTP メソッドで必要となるオプションの追加ヘッダーフィールド。
省略可能な HTTP 要求メッセージ本文のフィールド。URI および HTTP 操作をサポートするためのものです。たとえば、POST 操作には、複合パラメーターとして渡される MIME でエンコードされたオブジェクトが含まれます。 POST または PUT 操作の場合、本文の MIME エンコードの種類を Content-type 要求ヘッダーでも指定する必要があります。一部のサービスでは、application/json などの特定の MINE の種類を使用する必要があります。
HTTP 応答メッセージヘッダーのフィールド:
- HTTP 状態コード。成功コードの 2xx から、エラーコードの 4xx または 5xx までの範囲です。または、API のドキュメントに記載されているように、サービスで定義された状態コードが返されることもあります。
- Content-type 応答ヘッダーなど、要求の応答をサポートするために必要となるオプションの追加ヘッダーフィールド。
省略可能な HTTP 応答メッセージ本文のフィールド:
- MIME でエンコードされた応答オブジェクトが HTTP 応答の本文で返されます (データを返す GET メソッドからの応答など)。通常、これらのオブジェクトは、Content-type 応答ヘッダーで示される、JSON や XML などの構造化された形式で返されます。

API のドキュメント

最新の REST API には最新の API ドキュメントが必要です。 REST API は OpenAPI 仕様 (Swagger 仕様ともいう) に基づいてビルドされており、ドキュメントは SwaggerHub で入手できます。 SwaggerHub は、API の文書化だけでなく、任意の言語 (JavaScript、TypeScript、C#、Java、Python、Ruby など) でのクライアントライブラリの作成にも役立ちます。

API 呼び出しのテスト

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

次のステップ

SwaggerHub で利用可能な API を確認します。

サンプルは GitHub で入手できます。このサンプルには、TypeScript、React、Webpack でビルドされた HTML5 アプリと、PowerShell の例が含まれます。

その他の質問 Reporting Services のフォーラムに質問してみてください

Share via