REST v1 - Repository Services

This chapter documents the HTTP methods (sometimes called verbs) and parameters for each of these requests. In every case, you specify the folder, resource, or report to be acted up by adding its repository URI to the request URL. This chapter uses the following notation:

http://<host>:<port>/jasperserver[-pro]/rest/<service>/path/to/object

Arguments are passed in the URL with the conventional syntax:

http://<host>:<port>/jasperserver[-pro]/rest/<service>/path/to/object?<arg1>=<value>&<arg2>=<value>&...

The documentation for each method gives the list of arguments it supports. Optional arguments are listed with a question mark after the name, for example <arg2>?. Arguments that are not marked optional are mandatory and must be included in the URL with a valid value.

For authentication using the REST web services, see section REST Authentication.

The RESTful repository services gives responses that contain the same XML data structure that are used in the SOAP repository web service. These data structures are shown as examples throughout the chapter and documented in section Syntax of resourceDescriptor, with reference material in ResourceDescriptor API Constants.

This chapter includes the following sections:

The resources Service
The resource Service
Working with Dashboards
Working with Virtual Data Sources
Working with Domains
The permission Service
Version: 
Feedback
randomness