レポートインスタンスを使用すると、レポートの現在のページ設定を取得し、すべてのページ設定のプロパティを更新し、レポートの特定のページ設定プロパティを更新することができます。レポートサービスを使用するためのHTTP要求をサービスアプリケーションに送信するクライアントアプリケーションを作成できます。
レポートインスタンス内の現在のページ設定を指定されているインスタンスIDで取得するには、GETメソッドを使用する必要があります。要求URL、次のように実行するレポートの完全なパスとインスタンスIDを指定します。
GET: http://<host>[:port]/api/report/{folder path}/{report name}/$instances/{instance id}/pagesettings
サンプルコード |
コードのコピー
|
---|---|
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/pagesettings |
パラメータ
パラメータ | 説明 |
---|---|
Report Full Path | 実行するレポートの完全なパスを指定します。 例: FlexCommonTasks.flxr/MultiValue DataBound Parameters |
Instance Id | 実行するレポートのインスタンスIDを指定します。 |
レスポンスメッセージ
HTTPステータスコード | 原因 |
---|---|
200 | JSON文字列にIPageSettingsタイプのオブジェクトが含まれます。 |
404 | レポートパスまたはインスタンスIDが存在しません。 |
レポートインスタンス内のすべてのページ設定やプロパティを指定されているインスタンスIDで更新するには、PUTメソッドを使用する必要があります。実行するレポートの完全なパスおよびインスタンスIDは、次のように要求URLに指定されています。
PUT: http://<host>[:port]/api/report/{folder path}/{report name}/$instances/{instance id}/pagesettings
サンプルコード |
コードのコピー
|
---|---|
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/pagesettings |
パラメータ
パラメータ | 説明 |
---|---|
Report Full Path | 実行するレポートの完全なパスを指定します。 例: FlexCommonTasks.flxr/MultiValue DataBound Parameters |
Instance Id | 実行するレポートのインスタンスIDを指定します。 |
Report Page Settings | ページ設定を指定します。例: paperSize=custom&height=10in&width=20.5cm |
レスポンスメッセージ
HTTPステータスコード | 原因 |
---|---|
200 | JSON文字列には新しいページ設定であるIPageSettingsタイプのオブジェクトが含まれています。1つのプロパティーが設定されていない場合は、デフォルト値を使用します。 |
404 | レポートパスまたはインスタンスIDが存在しません。 |
レポートインスタンス内に指定されているインスタンスIDで特定のページ設定プロパティを更新するには、PATCHメソッドを使用する必要があります。レポートの完全なパスとインスタンスIDは、次のように要求URLに指定されています。
PUT: http://<host>[:port]/api/report/{folder path}/{report name}/$instances/{instance id}/pagesettings
サンプルコード |
コードのコピー
|
---|---|
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/pagesettings |
パラメータ
パラメータ | 説明 |
---|---|
Report Full Path | 実行するレポートの完全なパスを指定します。 例: FlexCommonTasks.flxr/MultiValue DataBound Parameters |
Instance Id | 実行するレポートのインスタンスIDを指定します。 |
Report Page Settings | ページを設定します。例: paperSize=custom&height=10in&width=20.5cm |
レスポンスメッセージ
HTTPステータスコード | 原因 |
---|---|
200 | JSON文字列に新しいページ設定であるIPageSettingsタイプのオブジェクトが含まれます。 |
404 | レポートパスまたはインスタンスIDが存在しません。 |
詳細については、WebApiExplorer のデモを参照してください。