Report instance allows you get information related to a specific bookmark using the bookmark name and also provides search functionality to get the search results of the report. You can create a client application to send an HTTP request to the service application for using the report services.
To get the bookmark using a specific bookmark name in the report instance with the specified instance id, you need to use GET method. Report full path and instance id of executing report is specified in the request URL, as follows:
GET: http://<host>[:port]/api/report/{folder path}/{report name}$instances/{instance id}/bookmarks/{bookmark name}
Request URL: https://developer.mescius.com/componentone/demos/aspnet/5/c1webapi/latest/api/report/ReportsRoot/FlexCommonTasks/FlexCommonTasks.flxr/Simple%20List$instances/21c2fa46-0a75-4708-acf2-454668eac4cb/bookmarks/bookmark1
Parameters
| Parameter | Description |
|---|---|
| Report Full Path | Specify the full path of the executing report. For example: FlexCommonTasks.flxr/Simple List |
| Instance Id | Specify the instance id of the executing report. |
| Bookmark Name | Specify the bookmark name. |
Response Messages
| HTTP Status Code | Reason |
|---|---|
| 200 | JSON string contains IDocumentPosition type object. |
| 404 | The report path or instance id or bookmark id does not exist. |
To get the search result of the report with the specified instance id, you need to use GET method. Report full path and instance id of executing report is specified in the request URL, as:
GET: http://<host>[:port]/api/report/{folder path}/{report name}$instances/{instance id}/search
Request URL: https://developer.mescius.com/componentone/demos/aspnet/5/c1webapi/latest/api/report/ReportsRoot/FlexCommonTasks/FlexCommonTasks.flxr/Simple%20List$instances/21c2fa46-0a75-4708-acf2-454668eac4cb/search?text=Steven Buchanan&matchCase=true&wholeWord=true
Parameters
| Parameter | Description |
|---|---|
| Report Full Path | Specify the full path of the executing report. For example: FlexCommonTasks.flxr/Simple List |
| Instance Id | Specify the instance id of the executing report. |
| Search Text | Specify a value which is used to search. |
| Match Case | Boolean value indicates if search the value with case sensitive. |
| Whole Word | Boolean value indicates if search the value with matching a whole word |
Response Messages
| HTTP Status Code | Reason |
|---|---|
| 200 | JSON string contains a collection of ISearchResult type objects. |
| 404 | The report path or instance id does not exist. |
To get all the outlines in the report instance with the specified instance id, you need to use GET method. Report full path and instance id of executing report is specified in the request URL, as:
GET: http://<host>[:port]/api/report/{folder path}/{report name}$instances/{instance id}/outlines
Request URL: https://developer.mescius.com/componentone/demos/aspnet/5/c1webapi/latest/api/report/ReportsRoot/FlexCommonTasks/FlexCommonTasks.flxr/Simple%20List$instances/21c2fa46-0a75-4708-acf2-454668eac4cb/outlines
Parameters
| Parameter | Description |
|---|---|
| Report Full Path | Specify the full path of the executing report. For example: FlexCommonTasks.flxr/Simple List |
| Instance Id | Specify the instance id of the executing report. |
Response Messages
| HTTP Status Code | Reason |
|---|---|
| 200 | JSON string contains collection of IOutlineNode type objects. |
| 404 | The report path or instance id does not exist. |
For more information about Report Instances. see WebApiExplorer Demo.
