インスタンス

レポートサービスでは、レポートインスタンスのGET、POST、UPDATE、およびDELETEメソッドが提供されています。レポートインスタンスは、新しいレポートインスタンスの作成、レポートインスタンスの情報の取得、およびレポートインスタンスのレンダリングをサポートされています。クライアントアプリケーションは、レポートインスタンスAPIを使用して特定のレポートインスタンスの情報を取得のHTTP要求をサービスアプリケーションに送信します。

[POST] 新しいインスタンスを作成します

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

POST: http://<host>[:port]/api/report/{folder path}/{report name}/$instances

サンプルコード	コードのコピー
http://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot /FlexCommonTasks/FlexCommonTasks.flxr/Simple List/$instances

パラメータ

パラメータ	説明
Folder Path	実行するレポートの完全なパスを指定します。例: FlexCommonTasks.flxr/Simple List
Report Name	FlexReportファイルやSSRSフォルダで定義されているレポート名を指定します。
Report Parameters	parametersアクションのレスポンスを参照してください。例: pCategory=1&... パラメータが複数値の場合は、複数回パラメータを設定してください。例: pCategory=1&pCustomers=3&...
Report Page Settings	ページの設定を指定します。例: `paperSize=custom&height=10in&width=20.5cm`

レスポンスメッセージ

HTTPステータスコード	原因
201	.JSON文字列には、新規に作成されたインスタンスのためにIReportInstanceInfoタイプオブジェクトが含まれています。
404	レポートパスが存在しません。

先頭に戻る

[GET] レポートの情報を取得します

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

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

サンプルコード	コードのコピー
http://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot /FlexCommonTasks/FlexCommonTasks.flxr/Simple List/$instances

パラメータ

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

レスポンスメッセージ

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

先頭に戻る

[POST] レポートをレンダリングします

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

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

`サンプルコード`	コードのコピー
http://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks /FlexCommonTasks.flxr/Simple List$instances/21c2fa46-0a75-4708-acf2-454668eac4cb/render

パラメータ

パラメータ	説明
Report Full Path	実行するレポートの完全なパスを指定します。例: FlexCommonTasks.flxr/MultiValue DataBound Parameters
Instance Id	実行するレポートのインスタンスIDを指定します。
Report Parameters	parametersアクションのレスポンスを参照してください。例: parameters.pCategory=1 パラメータが複数値の場合は、複数回パラメータを設定してください。例: pCategory=1&pCustomers=3&...
Report Page Settings	ページの設定を指定します。例: pageSettings.paperSize=custom&pageSettings.height=10in&pageSettings.width=20.5cm
Action String	アクションの文字列を指定します。これはSSRSレポートでのみ必要です。 AdventureWorks（SSRS）/Product Line Sales レポートを使用します。例: actionString=Sort;33iT0;Ascending

レスポンスメッセージ

HTTPステータスコード	原因
200	（レンダリング完了）JSON文字列にIReportStatusタイプのオブジェクトが含まれています。
202	（レンダリング時）レンダーアクションが受け入れられます。
404	レポートパスまたはインスタンスIDが存在しません。

先頭に戻る

[GET] レポートのステータスを取得します

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

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

`サンプルコード`	コードのコピー
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/status

サンプルコード

コードのコピー

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/status

パラメータ

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

レスポンスメッセージ

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

先頭に戻る

[DELETE] インスタンスを削除します

インスタンスを削除するには、DELETEメソッドを使用する必要があります。要求URLで、次のようにレポートの完全なパスとインスタンスIDを指定します。

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

`サンプルコード`	コードのコピー
http://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks /FlexCommonTasks.flxr/Simple List$instances/21c2fa46-0a75-4708-acf2-454668eac4cb

パラメータ

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

レスポンスメッセージ

HTTPステータスコード	原因
204	インスタンスを削除しました。
404	レポートパスまたはインスタンスIDが存在しません。

先頭に戻る

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