Requesting Report Output

This documentation is an older version of JasperReports Server Administration Guide. View the latest documentation.

Overview of JasperReports Server Administration
- Overview of Organizations
- Overview of the Repository
- Overview of Users and Roles
- Overview of Security
- Administrator Login
- Administrator Pages
Organization, User, and Role Management
- Managing Organizations
- Managing Users
- Managing Roles
Repository Administration
- Resource Types
- JasperReport Structure
- Managing Folders and Resources
- Multiple Organizations in the Repository
- Permissions
Resources in the Repository
- Data Sources
- Queries
- Input Controls
- Query-based Input Controls
- File Resources
Themes
- Introduction
- How Themes Work
- Administering Themes
- Working With CSS Files
Import and Export
- Import and Export Catalogs
- Setting the Import-Export Encryption Key
- Importing Unencrypted Catalogs
- Import and Export through the Web UI
- Import and Export through the Command Line
System Configuration
- Configuration Settings in the User Interface
- Configuring User Password Options
- Configuring the User Session Timeout
- Encrypting User Session Login
- Configuring CSRF Prevention
- Configuring Input Validation
- Defining a Cross-Domain Policy for Flash
- Configuring Ad Hoc
- Enabling Data Snapshots
- Configuring System Logs
- Configuring Amazon Web Services
- Configuring Domains
- Configuring JasperReports Library
- Configuring Input Control Behavior
- Configuring the Scheduler
- Configuring the Heartbeat
- Configuring the Online Help
Server Diagnostics
- Events Being Audited and Monitored
- Configuring Auditing and Monitoring
- Using the Audit Data
- Using the Monitoring Data
- Importing and Exporting Event Data
- Real-Time Diagnostics
- Exposing Diagnostics Through Jaspersoft’s JMX Agent
- Using the Diagnostic Data In Reports
- Excluding Diagnostic Attributes
- Disabling the Diagnostic Subsystem
Troubleshooting
Localization
Introduction
- REST Web Services Overview
- REST Authentication
- REST Server Information
- SOAP Web Services Overview
- SOAP Authentication
- Syntax of resourceDescriptor
REST v2 - Repository Services
- The v2/resources Service
- The_v2_domains_metadata_Service
- The v2/permissions Service
- The v2/export Service
  - Checking the Export State
  - Fetching the Export Output
- The v2/import Service
REST v2 - Report Services
- The v2/reports Service
- The v2/reportExecutions Service
- The v2/inputControls Service
- The v2/options Service
- The v2/jobs Service
- The v2/queryExecutor Service
- The v2/caches Service
REST v2 - Administration Services
- The v2/organizations Service
- The v2/users Service
- The v2/attributes Service
- The v2/roles Service
page
- The resources Service
- The resource Service
- Working with Dashboards
- Working with Virtual Data Sources
- Working with Domains
- The permission Service
  - Viewing Permissions
  - Setting Permissions
page
- The report Service
- The jobsummary Service
- The job Service
REST v1 - Administration Services
- The organization Service
- The user Service
- The attribute Service
- The role Service
page
- Request and Operation Result
- List Operation
- Get Operation
- Put Operation
- Delete Operation
- Move Operation
- Copy Operation
- Errors
- Implementation Suggestions
page
- Types Defined in the WSDL
- Operations in the Scheduling Service
  - Example Request and Operation Result
- Java Client Classes
SOAP - Domain Web Service
- Types Defined in the WSDL
- Operations in the Domain Service
SOAP - Web Services for Administration
- Types Defined in the WSDL
- Users and Roles
  - findUsers
  - page

After requesting a report execution and waiting synchronously or asynchronously for it to finish, your client is ready to download the report output.

Every export format of the report has an ID that is used to retrieve it. For example, the HTML export in the previous example has the ID 195a65cb-1762-450a-be2b-1196a02bb625. To download the main report output, specify this export ID in the following method:

Method	URL
GET	http://<host>:<port>/jasperserver[-pro]/rest_v2/reportExecutions/requestID/exports/exportID/outputResource
Response Header		Description
output-final		As of JasperReports Server 5.6, this value indicates whether the out put is in its final form or not. When false, report items such as total page count are not finalized, but output is available early. You should reload the output resource again until this value is true.
Return Value on Success			Typical Return Values on Failure
200 OK – The content is the main output of the report, in the format specified by the contentType property of the outputResource descriptor, for example: text/html			404 Not Found – When the request ID specified in the request does not exist.

For example, to download the main HTML of the report execution response above, use the following URL:

GET http://localhost:8080/jasperserver-pro/rest_v2/reportExecutions/b487a05a-4989-8b53-b2b9-b54752f998c4/exports/195a65cb-1762-450a-be2b-1196a02bb625/outputResource

JasperReports Server does not support exporting Highcharts charts with background images to PDF, ODT, DOCX, or RTF formats. When exporting or downloading reports with Highcharts that have background images to these formats, the background image is removed from the chart. The data in the chart is not affected.

To download file attachments for HTML output, use the following method. You must download all attachments to display the HMTL content properly. The given URL is the default path, but it can be modified with the attachmentsPrefix property in the reportExecutionRequest, as described in Report Execution Properties.

Method	URL
GET	http://<host>:<port>/jasperserver[-pro]/rest_v2/reportExecutions/requestID/exports/exportID/attachments/fileName
Return Value on Success		Typical Return Values on Failure
200 OK – The content is the attachment in the format specifiedin the contentType property of the attachment descriptor, for example: image/png		404 Not Found – When the request ID specified in the request does not exist.