パラメータ情報取得サービスは、Parameters APIを使用して、ユーザーが指定レポートのパラメータ記述を取得し、この情報を使用してパラメータパネルを初期化できるようにします。クライアントアプリケーションは、Parameters APIを使用するためのHTTP要求をサービスアプリケーションに送信します。

パラメータ情報サービスの要求スキーマ

クライアントからレポート内で定義されているすべてのパラメータの情報を取得するには、GETメソッドを使用する必要があります。要求URLで、次のようにレポートファイルのパスとレポート名を指定します。

GET: http://<host>[:port]/api/report/{report path}/$report/parameters

応答は、IParameterのコレクションを含むJSON文字列です。

次の図は、レポートのパラメータ記述を取得するためのパラメータを指定した要求URLを示しています。

URLパラメータ

パラメータサービスのURLは、第一にレポートパスのパラメータを受け取ります。要求URLで、レポートファイルパスを指定する必要があります。

レスポンスメッセージ

HTTPステータスコード	原因
200	Json文字列には、IParameterのコレクションが含まれます。
404	無効な{datasource}です。

パラメータサービスの要求スキーマ

レポート定義で指定されている名のパラメータを取得するには、GETメソッドを使用する必要があります。要求URLで、次のようにレポートファイルのパスとレポート名を指定します。

GET: http://<host>[:port]/api/report/{report path}/$report/parameters/{parametername}

URLパラメータ

パラメータサービスのURLは、第一にレポートパスとパラメータ名の2つのパラメータを受け取ります。要求URLで、レポートファイル名とレポート名を指定する必要があります。

レスポンスメッセージ

HTTPステータスコード	原因
200	Json文字列には、IParameter型オブジェクトが含まれます。
404	レポートのパス、または、パラメータ名が存在しません。

詳細については、WebApiExplorerのデモを参照してください。