REST Server Information

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

Use the following service to verify the server information, the same as the About JasperReports Server link in the user interface.

Method	URL
GET	http://<host>:<port>/jasperserver[-pro]/rest_v2/serverInfo
Options
accept: application/xml accept: application/json
Return Value on Success		Typical Return Values on Failure
200 OK – Body described below.		This request should always succeed when the server is running.

The server returns a structure containing the information in the requested format, XML or JSON:

<serverInfo>  <build>20141121_1750</build>  <dateFormatPattern>yyyy-MM-dd</dateFormatPattern>  <datetimeFormatPattern>yyyy-MM-dd'T'HH:mm:ss</datetimeFormatPattern>  <edition>PRO</edition>  <editionName>Enterprise</editionName>  <features>Fusion AHD EXP DB AUD ANA MT </features>  <licenseType>Commercial</licenseType>  <version>6.0.0</version></serverInfo>[/code]

{  "dateFormatPattern": "yyyy-MM-dd",  "datetimeFormatPattern": "yyyy-MM-dd'T'HH:mm:ss",  "version": "6.0.0",  "edition": "PRO",  "editionName": "Enterprise",  "licenseType": "Commercial",  "build": "20141121_1750",  "features": "Fusion AHD EXP DB AUD ANA MT "}[/code]

You can access each value separately with the following URLs. The response is the raw value, XML or JSON are not accepted formats.

Method	URL
GET	http://<host>:<port>/jasperserver[-pro]/rest_v2/serverInfo/version http://<host>:<port>/jasperserver[-pro]/rest_v2/serverInfo/edition http://<host>:<port>/jasperserver[-pro]/rest_v2/serverInfo/editionName http://<host>:<port>/jasperserver[-pro]/rest_v2/serverInfo/build http://<host>:<port>/jasperserver[-pro]/rest_v2/serverInfo/licenseType http://<host>:<port>/jasperserver[-pro]/rest_v2/serverInfo/features http://<host>:<port>/jasperserver[-pro]/rest_v2/serverInfo/dateFormatPattern http://<host>:<port>/jasperserver[-pro]/rest_v2/serverInfo/datetimeFormatPattern
Return Value on Success		Typical Return Values on Failure
200 OK – The requested value.		These requests should always succeed when the server is running.