ASP.NET Web API コントロール
パラメータ
サービス > レポートサービス > レポートのインスタンス > パラメータ

レポートインスタンスを使用すると、ユーザーが指定したレポートのパラメータの説明を取得し、レポート内のすべてのパラメータの値を更新し、レポート内の特定のパラメータを更新し、パラメータ名を使用して特定のパラメータの情報を取得することができます。レポートサービスを使用するためのHTTP要求をサービスアプリケーションに送信するクライアントアプリケーションを作成できます。

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

レポートインスタンス内のパラメータを指定されているインスタンスIDで取得するには、GETメソッドを使用する必要があります。 要求URLで、次のように実行するレポートの完全なパスとインスタンスIDを指定します。

GET: http://<host>[:port]/api/report/{folder path}/{report name}/$instances/{instance id}/parameters

サンプルコード
コードのコピー 
http://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks
/FlexCommonTasks.flxr/MultiValue DataBound Parameters/$instances/9e20a2d1-e371-44c2-87f2-bc65700172eb/parameters

パラメータ

パラメータ 説明
Report Full Path  実行するレポートの完全なパスを指定します。
 例: FlexCommonTasks.flxr/MultiValue DataBound Parameters
Instance Id 実行するレポートのインスタンスIDを指定します。

レスポンスメッセージ

HTTPステータスコード 原因
200 JSON文字列にはIParameterのコレクションが含まれます。
404 レポートパスが存在しません。

先頭に戻る

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

レポートインスタンスのすべてのパラメータ値を指定されているインスタンスIDで更新するには、 PUT メソッドを使用する必要があります。 要求URLで、次のようにレポートの完全なパスおよびインスタンスIDを指定します。

PUT: http://<host>[:port]/api/report/{folder path}/{report name}/$instances/{instance id}/parameters

サンプルコード
コードのコピー 
http://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks
/FlexCommonTasks.flxr/MultiValue DataBound Parameters/$instances/9e20a2d1-e371-44c2-87f2-bc65700172eb/parameters

パラメータ

パラメータ 説明
Report Full Path 実行するレポートの完全なパスを指定します。
 例:  FlexCommonTasks.flxr/MultiValue DataBound Parameters
Instance Id 実行するレポートのインスタンスIDを指定します。
Report Parameters parametersアクションのレスポンスを参照してください。 例: pCategory=1&...

パラメータが複数値の場合は、複数回パラメータを設定してください。 例: pCategory=1&pCustomers=3&...

レスポンスメッセージ

HTTPステータスコード 原因
200 JSON文字列にはIParameterインターフェースのコレクションが含まれます。検証を含む新しいパラメータ。
404 レポートパスまたはインスタンスIDが存在しません。

先頭に戻る

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

レポートインスタンスの特定のパラメータ値を指定されているインスタンスIDで更新するには、PATCHメソッドを使用する必要があります。要求URLで、次のように実行されたレポートの完全なパスとインスタンスIDを指定します。

PATCH: http://<host>[:port]/api/report/{folder path}/{report name}/$instances/{instance id}/parameters

サンプルコード
コードのコピー 
http://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks
/FlexCommonTasks.flxr/MultiValue DataBound Parameters/$instances/9e20a2d1-e371-44c2-87f2-bc65700172eb/parameters

パラメータ

パラメータ 説明
Report Full Path 実行するレポートの完全なパスを指定します。
 例: FlexCommonTasks.flxr/MultiValue DataBound Parameters
Instance Id 実行するレポートのインスタンスIDを指定します。
Report Parameters parametersアクションのレスポンスを参照してください。 例:pCategory=1&...
            
パラメータが複数値の場合は、複数回パラメータを設定してください。 例: pCategory=1&pCustomers=3&...

レスポンスメッセージ

HTTPステータスコード 原因
200 JSON文字列には、IParameterインターフェイスのコレクションが含まれています。 検証を含む新しいパラメータ。
404 レポートパスまたはインスタンスIDが存在しません。

先頭に戻る

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

指定したインスタンスIDを持つパラメータを特定のパラメータ名を使用して、レポートインスタンスに取得するには、GETメソッドを使用する必要があります。要求URLで、次のように実行されたレポートの完全なパスとインスタンスIDを指定します。

GET: http://<host>[:port]/api/report/{folder path}/{report name}/$instances/{instance id}/parameters/{parameterName}

サンプルコード
コードのコピー 
http://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks
/FlexCommonTasks.flxr/MultiValue DataBound Parameters/$instances/20f8e7c7-ea84-4961-81f7-5b8ff662f588/parameters/pCategory

パラメータ

パラメータ 説明
Report Full Path 実行するレポートの完全なパスを指定します。
 例: FlexCommonTasks.flxr/MultiValue DataBound Parameters
Instance Id 実行するレポートのインスタンスIDを指定します。
Parameter Name パラメータ名を指定します。例： pCategory

レスポンスメッセージ

HTTPステータスコード 原因
200 JSON文字列にはIParameterタイプのオブジェクトが含まれます。
404 レポートパスまたはインスタンスIDが存在しません。

先頭に戻る

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

レポートインスタンスのパラメータを特定のパラメータ名を使用して、指定されているインスタンスIDで取得するには、GETメソッドを使用する必要があります。要求URLで、次のように実行されたレポートの完全なパスとインスタンスIDを指定します。

PUT: http://<host>[:port]/api/report/{folder path}/{report name}/$instances/{instance id}/parameters/{parameterName}

サンプルコード
コードのコピー 
http://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks
/FlexCommonTasks.flxr/MultiValue DataBound Parameters/$instances/20f8e7c7-ea84-4961-81f7-5b8ff662f588/parameters/pCategory

パラメータ

パラメータ 説明
Report Full Path 実行するレポートの完全なパスを指定します。
 例: FlexCommonTasks.flxr/MultiValue DataBound Parameters
Instance Id 実行するレポートのインスタンスIDを指定します。
Parameter Name パラメータ名を指定します。 例： pCategory
Parameter Values レポートのパラメータ値を指定します。

レスポンスメッセージ

HTTPステータスコード 原因
200 JSON文字列には、IParameterインターフェイスのコレクションが含まれます。 検証を含む新しいパラメータ。
404 レポートパスまたはインスタンスIDが存在しません。

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

先頭に戻る

 

 

Copyright © MESCIUS, Inc. All rights reserved.