JasperReports Server’s web services allow client applications to interact with the server programmatically. Using the web services APIs, your application can query a running instance of JasperReports Server to display repository contents and run reports that are embedded into your application's own UI. This section gives a brief summary of the web services APIs; for complete documentation, see the JasperReports Server Web Services Guide.
Historically, there have been 3 different web service APIs:
• | SOAP (Simple Object Access Protocol) – As of JasperReports Server 5.5, the XML-based SOAP API is no longer supported. The SOAP APIs may still work in release 5.5, but Jaspersoft does not support their use anymore. |
• | REST v1 – As of JasperReports Server 5.5, the first generation of REST APIs are functional but deprecated. Jaspersoft will stop supporting the REST v1 APIs at some time in the future. Jaspersoft recommends you update your applications to use REST v2 APIs |
• | REST v2 – As of JasperReports Server 5.5, the REST v2 APIs cover all functionality of the REST v1 APIs and will be expanded in the future with new functionality. The REST v2 APIs provide better performance, added functionality, and full JSON support. |
The REST (REpresentational State Transfer) APIs depends on the standard methods provided by HTTP: GET, PUT, POST, and DELETE. Using these APIs, you can create client applications on any platform to access the server, interact with its resources, run reports, and with the right permissions, administer the server.
The REST v2 services in JasperReports Server6.0 include:
• | Repository web services, which allow you to search the repository; create, modify, and delete resources; view and set permissions on repository objects; and import and export repository catalogs. |
• | Report web services, which allow you to run reports and access report output; access and manipulate report options and input controls; and work with scheduled jobs. |
• | Administration web services, which allow you to work with users and user attributes, roles and role membership, and organizations in commercial editions. |
For full reference documentation of the REST v2 API, including resource descriptors in both JSON and XML formats, see the JasperReports Server Web Services Guide.
Jaspersoft also publishes a PHP client for embedding reports in PHP applications. The PHP client provides a wrapper for the REST v2 API, so that developers can use simple PHP structures and syntax to access JasperReports Server. For more information, see the PHP client community project.
.
Recommended Comments
There are no comments to display.