Reporting Services の REST API とは

  • [アーティクル]

適用対象: 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 レポート サーバー カタログ内のオブジェクトにプログラムでアクセスできます。 オブジェクトの例を次に示します。

  • フォルダー
  • Reports
  • KPI
  • データ ソース
  • データセット
  • プランを更新する
  • サブスクリプション

REST API を使用すると、フォルダー階層内の移動、フォルダーの内容の検出、レポート定義のダウンロードなどを行うことができます。 また、オブジェクトの作成、更新、および削除を行うこともできます。

Note

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

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

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

  • 要求 URI:

    • 要求 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 操作には、複合パラメーターとして渡される、Multipurpose Internet Mail Extensions (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 は、Swagger 仕様とも呼ばれる OpenAPI 仕様に基づいて構築されています。 Power BI Report Server REST API ドキュメントは、Microsoft Learn で入手できます。

API 呼び出しのテスト

HTTP 要求/応答メッセージをテストするツールが必要な場合は、REST 要求をインターセプトできる無料のウェブ デバッグ プロキシである Fiddler を使用することで、HTTP 要求/応答メッセーの診断が簡単になります。

関連するコンテンツ

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