Report Instances
Report services provides various APIs that help you to work with cached report instance. These are RESTful API services, which enable you to load, render, export, view parameters, and update page settings of a report. It can communicate with the ReportViewer control to display the report content on the web. The service URL includes the $instances keyword to access the cached information of a report.
$instances - Indicates functions for the report runtime.
You can make use of the following Web API services that are based on $instances keyword.
HTTP Methods | Description |
|---|---|
POST: /api/report/{reportpath}/$instances | Gets all cached report instances for the specified report path. |
GET: /api/report/{reportpath}/$instances/{instanceid} | Gets the info of cached report instance with the specified instance id. |
POST: /api/report/{folder path}/{report name}/$instances/{instance id}/render | Renders the report instance with the specified instance id |
GET: /api/report/{reportpath}/$instances/{instanceid}/status | Gets the status of the cached instance. |
DELETE: /api/report/{folder path}/{report name}/$instances/{instance id} | Delete the instance. |
GET: /api/report/{reportpath}/$instances/{instanceid}/parameters | Gets all parameters in the cached instance. |
PUT: /api/report/{folder path}/{report name}/$instances/{instance id}/parameters | Updates all parameter values in the report instance with specified instance id. |
PATCH: /api/report/{folder path}/{report name}/$instances/{instance id}/parameters | Updates specified parameter values in the report instance with specified instance id |
GET: /api/report/{reportpath}/$instances/{instanceid}/parameters/{parametername} | Gets info of the parameter with specified name in the cached instance. |
PUT: /api/report/{folder path}/{report name}/$instances/{instance id}/parameters/{parameterName} | Updates the value of parameter with specified name in the report instance with specified instance if. |
GET: /api/report/{reportpath}/$instances/{instanceid}/pagesettings | Gets the current page settings in the cached instance. |
PUT: /api/report/{folder path}/{report name}/$instances/{instance id}/pagesettings | Updates all page settings properties in the report instance with specified instance id. |
PATCH: /api/report/{folder path}/{report name}/$instances/{instance id}/pagesettings | Updates the specified page settings properties in the report instance with specified instance id. |
GET: /api/report/{reportpath}/$instances/{instanceid}/outlines | Gets the outlines of the report with specified in the cached instance. |
GET: /api/report/{reportpath}/$instances/{instanceid}/bookmarks/{bookmarkid} | Gets info of the bookmark with specified bookmark id in the cached instance. |
GET: /api/report/{reportpath}/$instances/{instanceid}/search?[text]&[matchCase]&[wholeWord] | Gets the search result in the cached instance. |
GET: /api/report/{reportpath}/$instances/{instanceid}/export?[options] | Exports the cached instance to specified format. |
POST: /api/report/{reportpath}/$instances/{instanceid}/export | Exports the cached instance to specified format |
GET: /api/report/{reportpath}/$instances/{instanceid}/supportedformats/{formatname} | Gets supported export format width the specified name for the report. |
GET: /api/report/{folder path}/{report name}/$instances/{instance id}/supportedformats | Gets all export formats supported by the report instance with specified instance id. |
GET: /api/report/{reportpath}/$instances/{instanceid}/features | Gets the features supported by the report instance. |