The serverInfo Service

The rest_v2/serverInfo service returns the same information as the About JasperReports Server link in the user interface.

Use the following methods to verify the server information, such as version number and supported features for compatibility with your REST client application. Your application should also use the date and date-time patterns to interpret all date or date-time strings it receives from the server and to format all date and date-time strings it sends to the server.

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>
 
{
  "dateFormatPattern": "yyyy-MM-dd",
  "datetimeFormatPattern": "yyyy-MM-dd'T'HH:mm:ss",
  "version": "6.0.0",
  "edition": "PRO",
  "editionName": "Enterprise",
  "licenseType": "Commercial",
  "build": "20150527_1942",
  "features": "Fusion AHD EXP DB AUD ANA MT "
}

You can access each value separately with the following URLs. Note that some information does not apply to community editions of the server. 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.