ASP.NET Web API コントロール
ブックマークと検索
サービス > レポートサービス > レポートのインスタンス > ブックマークと検索

レポートインスタンスでは、ブックマーク名を使用して特定のブックマークに関連する情報を取得できます。また、レポートの検索結果を取得するために検索機能も提供されます。 クライアントアプリケーションは、レポートサービスを使用するためのHTTP要求をサービスアプリケーションに送信します。

[GET] ブックマーク サービスの要求スキーマ

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

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

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

パラメータ

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

レスポンスメッセージ

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

先頭に戻る

[GET] 検索サービスの要求スキーマ

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

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

サンプルコード
コードのコピー
http://demos.componentone.com/ASPNET/c1webapi/4.0.20171.91/api/report/ReportsRoot/FlexCommonTasks
/FlexCommonTasks.flxr/Simple List/$instances/21c2fa46-0a75-4708-acf2-454668eac4cb
/search?text=Steven Buchanan&matchCase=true&wholeWord=true

パラメータ

パラメータ 説明
Report Full Path 実行するレポートの完全なパスを指定します。
例: FlexCommonTasks.flxr/Simple List
Instance Id 実行するレポートのインスタンスIDを指定します。
Search Text 検索するテキストを指定します。
Match Case 大文字と小文字を区別して値を検索するかどうかを示すBoolean値。
Whole Word 単語単位で値を検索するかどうかを示すBoolean値。

レスポンスメッセージ

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

先頭に戻る

[GET] アウトラインサービスの要求スキーマ

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

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

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

パラメータ

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

レスポンスメッセージ

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

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

先頭に戻る