README.md

Rest Client for JasperReports Server

With this library, you can develop Java applications which can interact with JasperReports Server through it's REST API, allowing the automation of interactive and administrative tasks.

Also the reporting REST services of jasperreports.io can be used with this library. Differences in jasperreports.io use will be highlighted in this documentation.

The test suite of the library includes live reporting examples of this client against JasperReports Server and jasperreports.io, and full code examples of this are included below.

Table of Contents

---

Introduction

1. Getting the JasperReports Server REST Client library.
2. Configuration.

• Loading configuration from file.
• Creation of manual configuration.
• HTTPS configuration.
• X-HTTP-Method override.
• Exception handling.
• Logging.
• Switching between JSON and XML.
• Client instantiation.

3. Authentication and Sessions.

• Authentication type.
• Anonymous session.
• jasperreports.io session.
• Invalidating session.

4. Using Sessions and Making Requests.
5. Report services.

• Running a report synchronously.
• Asynchronous report execution.
• Requesting report execution status.
• Requesting report execution details.
• Requesting Report Output.
• Download file attachments for report output.
• Exporting a Report Asynchronously.
• Polling Export Execution.
• Finding Running Reports and Jobs.
• Stopping Running Reports and Jobs.

6. Input controls service.

• Listing input controls structure.
• Reordering input controls structure.
• Listing input controls values.
• Setting input controls values.

7. Administration services.
8. Organizations service.

• Searching for Organizations.
• Viewing an Organization.
• Creating an Organization.
• Modifying Organization Properties.
• Deleting an Organization.

9. Users service.

• Searching for Users.
• Viewing a User.
• Creating a User.
• Modifying User Properties.
• Deleting a User.

10. Attributes service.

• Viewing User Attributes.
• Setting User Attributes.
• Deleting User Attributes.
• Viewing Organization Attributes.
• Setting Organization Attributes.
• Deleting Organization Attributes.
• Viewing Server Attributes.
• Setting Server Attributes.
• Deleting Server Attributes.
• Getting attributes permissions.
• Searching attributes .

11. The Roles Service.

• Searching for Roles.
• Viewing a Role.
• Creating a Role.
• Modifying a Role.
• Setting Role Membership.
• Deleting a Role.

12. The Settings Service.
13. Resources Service.

• Searching the Repository.
• Viewing Resource Details.
• Downloading File Resources.
• Creating a Resource.
• Modifying a Resource.
• Copying a Resource.
• Moving a Resource.
• Uploading SemanticLayerDataSource.
• Uploading MondrianConnection.
• Uploading SecureMondrianConnection.
• Uploading ReportUnit.
• Creating and Updating File and InputStream Resources.
• Deleting Resources.

14. The Permissions Service.

• Viewing Multiple Permissions.
• Viewing a Single Permission.
• Setting Multiple Permissions.
• Setting a Single Permission.
• Deleting Permissions in Bulk.
• Deleting a Single Permission.

15. Jobs service.

• Listing Report Jobs.
• Viewing a Job Definition.
• Extended Job Search.
• Scheduling a Report.
• Viewing Job Status.
• Editing a Job Definition.
• Updating Jobs in Bulk.
• Pausing Jobs.
• Resuming Jobs.
• Restarting Failed Jobs.

16. Calendars service.

• Listing All Registered Calendar Names.
• Viewing an Exclusion Calendar.
• Adding or Updating an Exclusion Calendar.
• Deleting an Exclusion Calendar.

17. Export service.

• Checking the Export Task.
• Fetching the Export Output.

18. Import service.

• Checking the Import Task.
• Managing the Import Task.

19. Domain metadata service.
20. Thumbnail Search Service.
21. Diagnostic Service.
22. Query Executor Service.
23. Server Information Service.
24. Bundles service.
25. Asynchronous API.
26. Getting serialized content from response.
27. Possible issues.
28. Maven dependency to add jasperserver-rest-client to your app.
29. License.

Introduction

---

With this client library, you can easily write Java applications which can interact with a JasperReports Server using the Server REST API, which is documented here: TIBCO JasperReports Server REST API Reference. This library provides a very friendly, high level Java API, which is productive and will improve the quality of your applications accessing the JasperReports Server.

Getting the JasperReports Server REST Client library

---

To use the library in your Maven-based Java applications, you need to specify the dependency and repository which are given below or download jar file manually from:

http://jaspersoft.artifactoryonline.com/jaspersoft/repo/com/jaspersoft/jrs-rest-java-client/{version}/jrs-rest-java-client-{version}.jar

You can also access the fork Sherman Wood has done at https://github.com/sgwood63/jrs-rest-java-client and build from there.

The only other dependency that may not be in all public Maven repositories is the jasperserver-dto project, which is part of the open source JasperReports Server Community edition.

Configuration

---

To start working with the library you should firstly configure one ore more instances of JasperserverRestClient. To do this you should create instance of RestClientConfiguration. It can be done in two ways:

• loading configuration from file;
• creation of manual configuration in java code.

Loading configuration from file:

RestClientConfiguration configuration = RestClientConfiguration.loadConfiguration("configuration.properties");

Here is example of configuration.properties file:

// required content
url=http://localhost:8080/jasperserver-pro
// optional content
connectionTimeout=20                        
readTimeout=20
jasperserverVersion=v6_0_0
authenticationType=SPRING
logHttp=true
logHttpEntity=true
restrictedHttpMethods=false
handleErrors=true
contentMimeType=JSON
acceptMimeType=JSON

File must contain at least URL which is entry point to your server's REST services and it is needed to URL corresponds to this pattern {protocol}://{host}:{port}/{contextPath}. Please notice, configuration settings may be changed after loading manually in java code.

Configuration in Java

To configure JasperserverRestClient manually, use the constructor of RestClientConfiguration and properties:

RestClientConfiguration configuration = new RestClientConfiguration("http://localhost:8080/jasperserver");
configuration.setAcceptMimeType(MimeType.JSON).setContentMimeType(MimeType.JSON).setJrsVersion(JRSVersion.v6_0_0).setLogHttp(true);

HTTPS configuration

To use HTTPS you need:

1. Configure your server to support HTTPS
2. Download InstallCert util and follow InstallCert-Guide instructions.
3. Set HTTPS as your protocol in server URL, e.g. https://localhost:8443/jasperserver
4. Configure trusted certificates if needed

RestClientConfiguration configuration = new RestClientConfiguration("https://localhost:8443/jasperserver");
X509TrustManager x509TrustManager = ...
TrustManager[] trustManagers = new TrustManager[1];
trustManagers[0] = x509TrustManager;
configuration.setTrustManagers(trustManagers);

X-HTTP-Method override

When your proxies or web services do not support arbitrary HTTP methods or newer HTTP methods, you can use “restricted mode”. In this mode JaperserverRestClient sends requests through POST method and set the X-HTTP-Method-Override header with value of intended HTTP method. To use this mode you should set flag RestrictedHttpMethods:

configuration.setRestrictedHttpMethods(true);

Or in configuration file:

restrictedHttpMethods=false

If you do not use the "restricted mode", POST or GET methods will result in the server returning a 411 error code. When this happens, the JaperserverRestClient will automatically resend the request through POST method with the X-HTTP-Method-Override header.

Exception handling

You can choose an exception handling strategy:

1. handling of errors directly. This mode is allowed by default.
2. getting operation result in any case with null entity and handling error after calling getEntity() method:

OperationResult<InputStream> result = session
                .thumbnailsService()
                .thumbnail()
                .report("/")
                .get(); // response status is 406, but exception won't be thrown
result.getEntity();     // the error will be handled and an exception will be thrown

To apply the second strategy, set handleErrors property of RestClientConfiguration to false:

configuration.setHandleErrors(false);

or specify this property in configuration file:

handleErrors=false

You can customize exception handling for each endpoint. To do this you need to pass com.jaspersoft.jasperserver.jaxrs.client.core.exceptions.handling.ErrorHandler implementation to JerseyRequestBuilder.buildRequest() factory method.

JRS REST client exception handling system is based on com.jaspersoft.jasperserver.jaxrs.client.core.exceptions.handling.ErrorHandler interface. Its void handleError(Response response) method is responsible for all error handling logic. You can use existed handlers, define your own handlers or extend existed handlers.

1. Existed handlers:

• com.jaspersoft.jasperserver.jaxrs.client.core.exceptions.handling.DefaultExceptionHandler - this implementation is suitable for most of the JRS errors, but sometimes you can meet some not standart errors and here such implementations as com.jaspersoft.jasperserver.jaxrs.client.apiadapters.jobs.JobValidationErrorHandler, com.jaspersoft.jasperserver.jaxrs.client.apiadapters.reporting.RunReportErrorHandler, etc. take responsibility.

2. You can create your own handler by implementing com.jaspersoft.jasperserver.jaxrs.client.core.exceptions.handling.ErrorHandler.
3. You can extend com.jaspersoft.jasperserver.jaxrs.client.core.exceptions.handling.DefaultExceptionHandler or any other handler and override its methods void handleBodyError(Response response) and/or void handleStatusCodeError(Response response, String overridingMessage).

Logging

Outgoing requests and incoming responses can be logged by using logHttp property of RestClientConfiguration:

config.setLogHttp(true);

Also, you are able to log entities using logHttpEntity option:

config.setLogHttpEntity(true).

In configuration file:

logHttp=true
logHttpEntity=true

Switching between JSON and XML

The client can send requests and receive responses in either with JSON or XML. The default is JSON.

RestClientConfiguration configuration = new RestClientConfiguration("http://localhost:4444/jasperserver");
configuration.setContentMimeType(MimeType.XML);
configuration.setAcceptMimeType(MimeType.XML);

Or in configuration.properties:

contentMimeType=JSON
acceptMimeType=JSON
or 
contentMimeType=XML
acceptMimeType=XML

Client instantiation

After configuration you need just to pass configuration instance to JasperserverRestClient constructor.

JasperserverRestClient client = new JasperserverRestClient(configuration);

Authentication and Sessions

---

This library automatically encrypts your password if password encryption has been configured on the target JasperReports Server, so to authenticate you need just specify login and password (not encrypted) in authenticate() method.

Session session = client.authenticate("jasperadmin", "jasperadmin");

//authentication with multi-tenancy
Session session = client.authenticate("jasperadmin|organization_1", "jasperadmin");

If you need to set user time zone different from the default system timezone (for example, for running reports) use the code below:

Session session = client.authenticate("jasperadmin", "jasperadmin", TimeZone.getTimeZone("America/Los_Angeles"));
// or
Session session = client.authenticate("jasperadmin", "jasperadmin", "America/Los_Angeles");

Also you can set user locale at authentication:

Session session = client.authenticate("jasperadmin", "jasperadmin", new Locale("de"), TimeZone.getTimeZone("America/Los_Angeles"));
// or
Session session = client.authenticate("jasperadmin", "jasperadmin", "de", America/Los_Angeles");

The session keeps track of all cookies returned from requests, including the JSESSIONID from the JasperReports Server. This allows proxies and load balancers to inject cookies into the JasperReports Server responses and have those additional cookies be returned in subsequent calls.

Authentication type

JasperserverRestClient supports SPRING and BASIC authentication types. SPRING authentication POSTs a form to the configured JasperReports Server /j_security_check directly/ URL. You obtain a JSESSIONID cookie of the authenticated session on successful authentication.

BASIC authentication uses HTTP Basic authentication, sending encrypted credentials with each request.

This API uses SPRING authentication by default. You can specify the authentication type in RestClientConfiguration instance:

configuration.setAuthenticationType(AuthenticationType.SPRING);

Or set authentication type in configuration file:

authenticationType=SPRING
or
authenticationType=BASIC

Please note that Basic authentication creates a session for each request and so cannot be used for "conversational" APIs like Report services).

Anonymous sessions

For some JasperReports Server services, authentication is not required (for example, settings service, bundles service or server info service), so you can use an anonymous session:

AnonymousSession session = client.getAnonymousSession();

jasperreports.io sessions

jasperreports.io does not have authentication, but needs full session tracking.

Session session = client.getUnauthenicatedSession();;

Invalidating sessions

You can invalidate the JasperReports Server user session with a logout().

session.logout();

There is no user session with jasperreports.io.

Using Sessions and making requests

The session is the gateway for sending REST requests to the JasperReports Server. For example, here is how to run a report and get the content in one request:

OperationResult<InputStream> result = session
        .reportingService()
        .report("/reports/samples/Cascading_multi_select_report")
        .prepareForRun(ReportOutputFormat.HTML, 1)
        .parameter("Cascading_name_single_select", "A & U Stalker Telecommunications, Inc")
        .run();
InputStream report = result.getEntity();

The result has result.getEntity() which is the body of the response. The type of the response can be seen in the class returned by the call, like OperationResult<InputStream> above. This Java REST client framework has mapping logic to convert response bodies to JasperReports Server Java objects (data transfer objects - "DTOs"), so that you have easy access to the information in your Java application. These DTO classes are also used to send information to the server, like this to create a folder:

ClientFolder folder = new ClientFolder();
String parentUri = "/reports";
folder
        .setUri("/reports/testFolder")
        .setLabel("Test Folder")
        .setDescription("Test folder description")
        .setPermissionMask(0)
        .setCreationDate("2014-01-24 16:27:47")
        .setUpdateDate("2014-01-24 16:27:47")
        .setVersion(0);

OperationResult<ClientResource> session
        .resourcesService()
        .resource(folder.getUri())
        .createOrUpdate(folder);    

If you need to get a plain response body, either JSON, XML, HTML or plain text, you can retrieve it:

OperationResult<UsersListWrapper> result = ...
result.getSerializedContent();

There is also result.getResponse(), a javax.ws.rs.core.Response object which contains the HTTP response to the request. These can be used to check the results of the request., get cookies etc.

result.getResponse.getStatus() // HTTP status code

result.getResponse.getHeaderString("Total-Count") // get Total-Count header

If you are using the default exception handling approach, outlined in Exception Handling, you need to be checking the getStatus() as no exceptions will be raised if there are errors.

In your use of this REST client, you should create a session and reuse it as much as possible in your application. This will maintain a user session in the JasperReports Server until you log the session out, or there is no activity on the session for the session expiry time configured on the server. There are many operations that require the use of the same session, like asynchronously running a report and then getting it's output.

The Sessions (not AnonymousSessions) track all cookies, which allows the Session to work with proxies and load balancers.

Report services

Report execution and types of output

There are two approaches to run a report and get output documents - synchronously in a single request/response, and asynchronously which requires a number of calls execute the report and retrieve the output.

Note the majority of report output is a single document, but that HTML output has additional "attachments" - images, etc - that need to be included to complete the output. The attachments can be loaded in two ways.

1. Let a browser access the attachments

Set an attachment prefix on the report request and provide a proxy service to get the attachments.

OperationResult<InputStream> result = session
        .reportingService()
        .report("/reports/samples/Cascading_multi_select_report")
        .prepareForRun(ReportOutputFormat.HTML, 1)
        .setAttachmentPrefix("path/to/attachmentProxy?execution={reportExecutionId}&export={exportExecutionId}&attachment=")
        .run();
InputStream report = result.getEntity();

Based on the attachment prefix set, the generated HTML output for a report will include URLs for attachments like: path/to/attachmentProxy?execution=&export=&attachment=

The proxy you will need to write needs to pass a request through to the attachments service.

/rest_v2/reportExecutions/{reportExecutionId}/exports/ {exportExecutionId}/attachments/{filename}

With this approach, the browser will request the attachments as the page loads and your proxy will make the REST requests to retrieve them.

2. Retrieve and manage the attachments

Using an asynchronous report execution call:

• set the attachmentPrefix to where you are going to store the attachment files
• as part of processing the asynchronous responses: ** retrieve the attachments (#download-file-attachments-for-report-output) ** store the attachment files in your environment

The HTML output will include include URLs to GET the attachments from your environment.

This approach does not work for jasperreports.io 1.0.

Running a report synchronously

To run a report in synchronous mode you use:

OperationResult<InputStream> result = session
        .reportingService()
        .report("/reports/samples/Cascading_multi_select_report")
        .prepareForRun(ReportOutputFormat.PDF, 1)
        .parameter("Cascading_name_single_select", "A & U Stalker Telecommunications, Inc")
        .run();
InputStream report = result.getEntity();

This corresponds to the Jaspersoft REST API:

GET /rest_v2/reports/path/to/report.?

You can set format of report as String as well(name of format is case insensitive):

OperationResult<InputStream> result = session
        .reportingService()
        .report("/reports/samples/Cascading_multi_select_report")
        .prepareForRun("HTML", 1)
        .parameter("Cascading_name_single_select", "A & U Stalker Telecommunications, Inc")
        .run();

Also you can use this method to run report with several values for the same parameter. In this case new values of the parameter are added to the previous ones (new values do not replace previous values of the parameter):

OperationResult<InputStream> result = session
        .reportingService()
        .report("/reports/samples/Cascading_multi_select_report")
        .prepareForRun(ReportOutputFormat.PDF, 1)
        .parameter("Cascading_state_multi_select", "CA")
        .parameter("Cascading_state_multi_select",  "OR", "WA")
        .parameter("Cascading_name_single_select", "Adams-Steen Transportation Holdings")
        .parameter("Country_multi_select", "USA")
        .run();

Please notice, if you pass zero as number of pages, you will get all pages of report.

If you need run report in another time zone specify it using forTimeZone() method:

OperationResult<InputStream> result = session
                .reportingService()
                .report("/public/Samples/Reports/12g.PromotionDetailsReport")
                .prepareForRun(ReportOutputFormat.PDF, 1)
                .forTimeZone(TimeZone.getTimeZone("America/Los_Angeles"))
                .run();
InputStream report = result.getEntity();

 // or set time zones as string

OperationResult<InputStream> result = session
                .reportingService()
                .report("/public/Samples/Reports/12g.PromotionDetailsReport")
                .prepareForRun(ReportOutputFormat.PDF, 1)
                .forTimeZone("America/Los_Angeles")
                .run();

Asynchronous report execution

Reports can also be executed asynchronously so that requesting processes are not blocked waiting for responses. This is used in visualize.js to allow browsers to execute report requests in parallel.

The asynchronous report execution process is:

• Request an asynchronous report execution
• Poll report execution status until the report is ready
• (jasperreports.io only) request an export of the report
• (optional) poll report export status until ready
• get report output
• (HTML only) get attachment files

In order to run a report in asynchronous mode, you build a ReportExecutionRequest object and specify the parameters needed to launch a report. The response from the server is the ReportExecutionDescriptor instance which contains the request ID needed to track the execution until completion, get output etc.

Here's the code to run a report asynchronously:

//instantiating request and specifying report parameters
ReportExecutionRequest request = new ReportExecutionRequest();
request.setReportUnitUri("/reports/samples/StandardChartsReport");
request
        .setAsync(true)
        .setOutputFormat(ReportOutputFormat.HTML);               //report can be requested in different formats e.g. html, pdf, etc.

OperationResult<ReportExecutionDescriptor> operationResult =
        session
                .reportingService()
                .newReportExecutionRequest(request);

reportExecutionDescriptor = operationResult.getEntity();

As a response we've got OperationResult instance which contains HTTP response wrapper and instance of ReportExecutionDescriptor which we can get with operationResult.getEntity().

This corresponds to the Jaspersoft REST API:

POST /rest_v2/reportExecutions

As in synchronous mode, you can set the report time zone and other parameters:

ReportExecutionRequest request = new ReportExecutionRequest();
request
                .setOutputFormat(ReportOutputFormat.PDF)  // or string "pdf", "html", ...
                .setPages("1")
                .setTimeZone(TimeZone.getTimeZone("America/Los_Angeles"))
                .setReportUnitUri("/public/Samples/Reports/12g.PromotionDetailsReport")
                .setAsync(true);            

Requesting report execution status

After you've got ReportExecutionDescriptor you can request for the report execution status:

OperationResult<ReportExecutionStatusEntity> operationResult =
        session
                .reportingService()
                .reportExecutionRequest(reportExecutionDescriptor.getRequestId())
                .status();

ReportExecutionStatusEntity statusEntity = operationResult.getEntity();

In the above code we've just specified request ID and got its status as a ReportExecutionStatusEntity instance.

This corresponds to the Jaspersoft REST API:

GET /rest_v2/reportExecutions//status

Requesting report execution details

Once the report execution is ready, your client must determine the names of the files to download by requesting the reportExecution descriptor again.

OperationResult<ReportExecutionDescriptor> operationResult =
        session
                .reportingService()
                .reportExecutionRequest(reportExecutionDescriptor.getRequestId())
                .executionDetails();

ReportExecutionDescriptor descriptor = operationResult.getEntity();

This corresponds to the Jaspersoft REST API:

GET /rest_v2/reportExecutions/

In JasperReports Server, the ReportExecutionDescriptor contains the details and status of the report execution, as well as the exported files/content of the report. After the report is ready, the output generation starts. You can repeatedly get the executionDetails to poll for the output generation status.

You will need to get the exportId of the output being generated in order to request the content.

		  // After the reportExecution is ready
		  
        String exportStatus = null;
        String exportId = null;
        do {
        	if (exportStatus != null) {
        		try {
					Thread.sleep(100);
				} catch (InterruptedException e) { }
        	}
	        // get execution details
	        OperationResult<ReportExecutionDescriptor> operationResultRED =
	                session
	                        .reportingService()
	                        .reportExecutionRequest(reportExecutionDescriptor.getRequestId())
	                        .executionDetails();
	
	        assertTrue(operationResultRED.getResponseStatus() == 200);
	
	        ReportExecutionDescriptor descriptor = operationResultRED.getEntity();
	        System.out.println(descriptor);
	        
	        for (ExportDescriptor ed : descriptor.getExports()) {
	        	System.out.println(ed);
	        	// find PDF descriptor
	        	if (ed.getOutputResource() != null && ed.getOutputResource().getContentType().contains("pdf")) {
	        			exportStatus = ed.getStatus();
	        			exportId = ed.getId();
	        	}
	        }
	        System.out.println("export status: " + exportStatus + ", " + exportId);
        } while (exportStatus == null || exportStatus.equalsIgnoreCase("queued")  ||
        		exportStatus.equalsIgnoreCase("execution"));

        assertTrue(exportStatus.equalsIgnoreCase("ready"));

jasperreports.io does not include details of it's output in the executionDetails. A separate report export execution will need to be made, once the asynchronous jasperreports.io report execution is ready. See Exporting a Report Asynchronously.

Requesting Report Output

After requesting a report execution and waiting synchronously or asynchronously for it to finish, you are ready to download the report output. To download the main report output, specify this export ID in the export method. For example, to download the main HTML of the report execution response above, use the following code:

OperationResult<InputStream> operationResult =
        session
                .reportingService()
                .reportExecutionRequest(reportExecutionDescriptor.getRequestId())
                .export(exportId)
                .outputResource();

InputStream file = operationResult.getEntity();

This corresponds to the Jaspersoft REST API:

GET /rest_v2/reportExecutions//exports//outputResource

As a response you'll get an InputStream instance.

Download file attachments for report output

To download file attachments for HTML output, use the following code. You must download all attachments to display the HMTL content properly.

ExportDescriptor htmlExportDescriptor = ... //retrieving htmlExportDescriptor from reportExecutionDescriptor

for(AttachmentDescriptor attDescriptor : htmlExportDescriptor.getAttachments()){
    OperationResult<InputStream> operationResult =
            session
                    .reportingService()
                    .reportExecutionRequest(reportExecutionDescriptor.getRequestId())
                    .export(htmlExportDescriptor.getId())
                    .attachment(attDescriptor.getFileName());

    InputStream file = operationResult.getEntity();
    //doing something with file
}

This corresponds to the Jaspersoft REST API:

GET /rest_v2/reportExecutions//exports// /attachments/

This does not work for jasperreports.io 1.0.

Exporting a Report Asynchronously

After running a report and downloading its content in a given format, you can request the same report in other formats. As with exporting report formats through the user interface, the report execution does not run again because the export process is independent of the report execution.

ExportExecutionOptions exportExecutionOptions = new ExportExecutionOptions()
        .setOutputFormat(ReportOutputFormat.PDF)
        .setPages("3");

OperationResult<ExportExecutionDescriptor> operationResult =
        session
                .reportingService()
                .reportExecutionRequest(reportExecutionDescriptor.getRequestId())
                .runExport(exportExecutionOptions);

ExportExecutionDescriptor statusEntity = operationResult.getEntity();

String exportId = statusEntity.getId();

This corresponds to the Jaspersoft REST API:

POST /rest_v2/reportExecutions//exports

Polling Export Execution

As with the execution of the main report, you can also poll the execution of the export process. For example, to get the status of the HTML export in the previous example, use the following code:

OperationResult<ReportExecutionStatusEntity> operationResult =
        session
                .reportingService()
                .reportExecutionRequest(reportExecutionDescriptor.getRequestId())
                .export(exportId)
                .status();

ReportExecutionStatusEntity statusEntity = operationResult.getEntity();

This corresponds to the Jaspersoft REST API:

POST /rest_v2/reportExecutions//exports//status

Finding Running Reports and Jobs

You can search for reports that are running on the JasperReports Server, including report jobs triggered by the scheduler.

This request is not valid for jasperreports.io.

To search for running reports, use the search arguments from ReportAndJobSearchParameter enumeration.

OperationResult<ReportExecutionListWrapper> operationResult =
        session
                .reportingService()
                .runningReportsAndJobs()
                .parameter(ReportAndJobSearchParameter.REPORT_URI, "/reports/samples/AllAccounts")
                .find();

ReportExecutionListWrapper entity = operationResult1.getEntity();

This corresponds to the Jaspersoft REST API:

GET /rest_v2/reportExecutions?

Stopping Running Reports and Jobs

To stop a report that is running and cancel its output, use the code below:

OperationResult<ReportExecutionStatusEntity> operationResult1 =
        session
                .reportingService()
                .reportExecutionRequest(executionDescriptor.getRequestId())
                .cancelExecution();

ReportExecutionStatusEntity statusEntity = operationResult1.getEntity();

This corresponds to the Jaspersoft REST API:

PUT /rest_v2/reportExecutions//status

with a body of { "value": "cancelled" }

Input controls services

The reports service includes methods for reading and setting input controls of any input controls container, i.e. reportUnit, reportOptions, dashboard, adhocDataView

Listing Input Controls Structure

The following code returns a description of the structure of the input controls for a given container.

 OperationResult<ReportInputControlsListWrapper> operationResult = session
                .inputControlsService()
                .inputControls()
                .container("/reports/samples/Cascading_multi_select_report")
                .get();
 ReportInputControlsListWrapper result = operationResult.getEntity();

The response contains the structure of the input controls for the container. It contains the information needed by your application to display the report parameters to your users and allow them to make a selection. In particular, this includes any cascading structure as a set of dependencies between container parameters. Each input control also has a type that indicates how the user should be allowed to make a choice: bool, singleSelect, singleSelectRadio, multiSelectCheckbox, multiSelect, singleValue, singleValueText, singleValueNumber, singleValueDate, singleValueDatetime, singleValueTime. The structure includes a set of validation rules for each report parameter. These rules indicate what type of validation your client should perform on input control values it receives from your users, and if the validation fails, the message to display. Depending on the type of the report parameter, the following validations are possible:

• mandatoryValidationRule – This input is required and your client should ensure the user enters a value.
• dateTimeFormatValidation – This input must have a data time format and your client should ensure the user enters a valid date and time. To skip input controls state generation use excludeState(true) setting:

OperationResult<ReportInputControlsListWrapper> operationResult = session
                .inputControlsService()
                .inputControls()
                .container("/reports/samples/Cascading_multi_select_report")
                .excludeState(true)
                .get();
ReportInputControlsListWrapper result = operationResult.getEntity();

Reordering input controls structure

You can change structure of input controls according to client demands using the next code:

OperationResult<ReportInputControlsListWrapper> reorderedOperationResult = session
                .inputControlsService()
                .inputControls()
                .container("/reports/samples/Cascading_multi_select_report")
                .reorder(inputParameters);

It is impossible to change input controls except change of theirs order. Sent to server structure MUST be the same as it received from there, except order. You cannot modify some values, add or remove control, etc.

Listing input controls values

The following code returns a description of the possible values of all report parameters for the report. Among these choices, it shows which ones are selected.

OperationResult<InputControlStateListWrapper> operationResult = session
                .inputControlsService()
                .inputControls()
                .container("/reports/samples/Cascading_multi_select_report")
                .values()
                .get();
 InputControlStateListWrapper result = operationResult.getEntity();

The response contains the structure of the report parameters for the report. If a selection-type report parameter has a null value, it is given as NULL. If no selection is made, its value is given as NOTHING. Use setting useCashedData(false) to avoid getting cashed data:

 OperationResult<InputControlStateListWrapper> operationResult = session
                .inputControlsService()
                .inputControls()
                .container("/reports/samples/Cascading_multi_select_report")
                .values()
                .useCashedData(false)
                .get();
InputControlStateListWrapper result = operationResult.getEntity();

Setting input controls values

The following code updates the state of specified input controls values, so they are set for the next run of the report.

OperationResult<InputControlStateListWrapper> operationResult = session
                .inputControlsService()
                .inputControls()
                .container("/reports/samples/Cascading_multi_select_report")
                .values()
                .parameter("Country_multi_select", "Mexico")
                .parameter("Cascading_state_multi_select", "Guerrero", "Sinaloa")
                .run();
InputControlStateListWrapper result = operationResult.getEntity();

In response you get updated values for specified input controls. If you want to get updated values with full structure of input controls, you should use includeFullStructure(true) setting:

OperationResult<InputControlStateListWrapper> operationResult = session
                .inputControlsService()
                .inputControls()
                .container("/reports/samples/Cascading_multi_select_report")
                .values()
                .parameter("Country_multi_select", "USA")
                .parameter("Cascading_state_multi_select", "CA", "OR", "WA")
                .includeFullStructure(true)
                .run();
InputControlStateListWrapper result = operationResult.getEntity();

Administration services

======================== Only administrative users with ROLE__ADMINISTRATOR and ROLE__SUPERUSER may access the REST services for administration.

Organizations service

It provides methods that allow you to list, view, create, modify, and delete organizations (also known as tenants). Because the organization ID is used in the URL, this service can operate only on organizations whose ID is less than 100 characters long and does not contain spaces or special symbols. As with resource IDs, the organization ID is permanent and cannot be modified for the life of the organization. ##Searching for Organizations The service searches for organizations by ID, alias, or display name. If no search is specified, it returns a list of all organizations. Searches and listings start from but do not include the logged-in user’s organization or the specified base.

OperationResult<OrganizationsListWrapper> result = session
        .organizationsService()
        .allOrganizations()
        .parameter(OrganizationParameter.INCLUDE_PARENTS, "true")
        .get();

Viewing an Organization

The organization() method with an organization ID retrieves a single descriptor containing the list of properties for the organization. When you specify an organization, use its unique ID, not its path.

OperationResult<ClientTenant> result = session
        .organizationsService()
        .organization("myOrg1")
        .get();

Also you may specify organization as object:

ClientTenant organization = new ClientTenant();
organization.setId("test_Id");

OperationResult<ClientTenant> result = session
        .organizationsService()
        .organization(organization)
        .get();

Creating an Organization

To create an organization, put all information in an organization descriptor, and include it in a request to the rest_v2/organizations service, with no ID specified. The organization is created in the organization specified by the parentId value of the descriptor.

OperationResult<Organization> result = session
        .organizationsService()
        .organization(organization)
        .create();

The another way to create organization is to use createOrUpdate() method:

OperationResult<Organization> result = session
        .organizationsService()
        .organization(organization)
        .createOrUpdate(organization);

Be carefully using this method because you can damage existing organization if the organizationId of new organization is already used. The descriptor is sent in the request should contain all the properties you want to set on the new organization. Specify the parentId value to set the parent of the organization, not the tenantUri or tenantFolderUri properties. However, all properties have defaults or can be determined based on the alias value. The minimal descriptor necessary to create an organization is simply the alias property. In this case, the organization is created as child of the logged-in user’s home organization.

Modifying Organization Properties

To modify the properties of an organization, use the update method and specify the organization ID in the URL. The request must include an organization descriptor with the values you want to change. You cannot change the ID of an organization, only its name (used for display) and its alias (used for logging in).

Organization organization = new Organization();
organization.setAlias("lalalaOrg");

OperationResult<ClientTenant> result = session
        .organizationsService()
        .organization("myOrg1")
        .createOrUpdate(organization);

Deleting an Organization

To delete an organization, use the delete() method and specify the organization ID in the organization() method. When deleting an organization, all of its resources in the repository, all of its sub-organizations, all of its users, and all of its roles are permanently deleted.

OperationResult<ClientTenant> result = session
        .organizationsService()
        .organization("myOrg1")
        .delete();

Users service

It provides methods that allow you to list, view, create, modify, and delete user accounts, including setting role membership. Because the user ID is used in the URL, this service can operate only on users whose ID is less than 100 characters long and does not contain spaces or special symbols. As with resource IDs, the user ID is permanent and cannot be modified for the life of the user account.

Searching for Users

You can search for users by name or by role. If no search is specified, service returns all users.

OperationResult<UsersListWrapper> operationResult =
        session
                .usersService()
                .allUsers()
                .param(UsersParameter.REQUIRED_ROLE, "ROLE_USER")
                .get();

UsersListWrapper usersListWrapper = operationResult.getEntity();

Viewing a User

Method username() with a user ID (username) retrieves a single descriptor containing the full list of user properties and roles.

OperationResult<ClientUser> operationResult =
        session
                .usersService()
                .user("jasperadmin")
                .get();

ClientUser user = operationResult.getEntity();

Also you may specify user as object:

ClientUser userObject = new ClientUser()
                .setUsername("test_user")
                .setPassword("test_password")
                .setEmailAddress("[email protected]")
                .setEnabled(true)
                .setExternallyDefined(false)
                .setFullName("John Doe");
OperationResult<ClientUser> operationResult =
        session
                .usersService()
                .user(userObject)
                .get();

ClientUser user = operationResult.getEntity();

The full user descriptor includes detailed information about the user account, including any roles.

Creating a User

To create a user account, put all required information in a user descriptor ClientUser, and include it in a request to the users service (createOrUpdate() method), with the intended user ID (username) specified in the username() method. To create a user, the user ID in the username() method must be unique on the server. If the user ID already exists, that user account will be modified. The descriptor sent in the request should contain all the properties you want to set on the new user, except for the username that is specified in the username() method. To set roles on the user, specify them as a list of roles.

//Creating a user
ClientUser user = new ClientUser()
        .setUsername("john.doe")
        .setPassword("12345678")
        .setEmailAddress("[email protected]")
        .setEnabled(true)
        .setExternallyDefined(false)
        .setFullName("John Doe");

session
    .usersService()
    .user(user.getUsername())
    .createOrUpdate(user);

//Granting new user with admin role
ClientRole role = session
        .rolesService()
        .rolename("ROLE_ADMINISTRATOR")
        .get()
        .getEntity();

Set<ClientRole> roles = new HashSet<ClientRole>();
roles.add(role);
user.setRoleSet(roles);

session
    .usersService()
    .user(user.getUsername())
    .createOrUpdate(user);

Modifying User Properties

To modify the properties of a user account, put all desired information in a user descriptor (ClientUser), and include it in a request to the users service (createOrUpdate() method), with the existing user ID (username) specified in the username() method. To modify a user, the user ID must already exist on the server. If the user ID doesn’t exist, a user account will be created. To add a role to the user, specify the entire list of roles with the desired role added. To remove a role from a user, specify the entire list of roles without the desired role removed.

ClientUser user = new ClientUser()
        .setUsername("john.doe")
        .setPassword("12345678")
        .setEmailAddress("[email protected]")
        .setEnabled(true)
        .setExternallyDefined(false)
        .setFullName("Bob");                    //field to be updated

client
    .authenticate("jasperadmin", "jasperadmin")
    .usersService()
    .user("john.doe")
    .createOrUpdate(user);

Deleting a User

To delete a user, call the delete() method and specify the user ID in the username() method.

session
    .usersService()
    .user(user.getUsername())
    .delete();

Attributes service

Attributes, also called profile attributes, are name-value pairs associated with a user, organization or server. Certain advanced features such as Domain security and OLAP access grants use profile attributes in addition to roles to grant certain permissions. Unlike roles, attributes are not pre-defined, and thus any attribute name can be assigned any value at any time. Attributes service provides methods for reading, writing, and deleting attributes on any given holder (server, organization or user account). All attribute operations apply to a single specific holder; there are no operations for reading or searching attributes from multiple holders. As the holder's id is used in the URL, this service can operate only on holders whose ID is less than 100 characters long and does not contain spaces or special symbols. In addition, both attribute names and attribute values being written with this service are limited to 255 characters and may not be empty (null) or not contain only whitespace characters.

Viewing User Attributes

The code below allow you to retrieve single attribute defined for the user:

   HypermediaAttribute userAttribute = session
                   .attributesService()
                   .forUser("jasperadmin")
                   .attribute(attribute.getName())
                   .get()
                   .getEntity();

You may work work with user as object:

    CleintUser userObject = new ClientUser();
    userObject.setName("jasperadmin");
    HypermediaAttribute userAttribute = session
                       .attributesService()
                       .forUser(userObject)
                       .attribute(attribute.getName())
                       .get()
                       .getEntity();

If user belong to organization you may specify it by name or as object:

 HypermediaAttribute userAttribute = session
                 .attributesService()
                 .forOrganization("organization_1")
                 .forUser("jasperadmin")
                 .attribute(attribute.getName())
                 .get()
                 .getEntity();

  ClientTenant orgObject = new CleintTenant();
  orgObject.setId("someId");
 
 HypermediaAttribute userAttribute = session
                 .attributesService()
                 .forOrganization(orgObject)
                 .forUser("jasperadmin")
                 .attribute(attribute.getName())
                 .get()
                 .getEntity();

The code below retrieves the list of attributes defined for the user.

   HypermediaAttribute userAttribute = session
                   .attributesService()
                   .forUser("jasperadmin")
                   .attribute("attributeName", "attributeName1", "attributeName2")
                   .get()
                   .getEntity();

If user belong to organization you may specify organization:

 HypermediaAttribute userAttribute = session
                 .attributesService()
                 .forOrganization("organization_1")
                 .forUser("jasperadmin")
                 .allAttributes()
                 .get()
                 .getEntity();

You can get the list of all attributes that includes the name and value of each attribute:

List<HypermediaAttribute> attributes = session
                .attributesService()
                .forOrganization("organization_1")
                .forUser("jasperadmin")
                .allAttributes()
                .get()
                .getEntity()
                .getProfileAttributes();

Each attribute may only have one value, however that value may contain a comma-separated list that is interpreted by the server as being multi-valued.

Setting User Attributes

The createOrUpdate() method of the attributes service adds or replaces attributes on the specified user. The list of attributes defines the name and value of each attribute. Each attribute may only have one value, however, that value may contain a comma separated list that is interpreted by the server as being multi-valued. There are two syntaxes, the following one is for adding or replacing all attributes

HypermediaAttributesListWrapper serverAttributes = new HypermediaAttributesListWrapper();
serverAttributes.setProfileAttributes(asList(new HypermediaAttribute(new ClientUserAttribute().setName("test_attribute_1").setValue("test_value_1")),
                                             new HypermediaAttribute(new ClientUserAttribute().setName("test_attribute_2").setValue("test_value_2"))));
       session
                       .attributesService()
                       .forOrganization("organization_1")
                       .forUser("jasperadmin")
                       .attributes("test_attribute_1","test_attribute_2")
                       .createOrUpdate(serverAttributes);

Be careful with definition of attribute names because the server uses different strategies for creating or updating attributes depending on list of attribute names, list of attributes and existing attributes on the server:

1. if requested attributes' names in attributes() method matches with attribute name of object defined in createOrUpdate() method and the attribute does not exist on the server it will be created on the server;
2. if requested attributes' names in attributes() method matches with attribute name of object defined in createOrUpdate() method and the attribute exists on the server it will be updated on the server;
3. if requested attributes' names in attributes() method does not match with any attribute names of object defined in createOrUpdate() method and the attribute exists on the server it will be deleted on the server;
4. if requested attribute in createOrUpdate() method method does not match with any attribute names in attributes() it will be ignored and will not be sent to the server;
5. if requested list of attributes' names in attributes() method is empty or you use allAttributes() method and pass attributes in createOrUpdate() method - the existing attributes on the server it will be complitely replaced with passed ones:

 session
                      .attributesService()
                      .forOrganization("organization_1")
                      .forUser("jasperadmin")
                      .allAttributes()
                      .createOrUpdate(serverAttributes);

The second way of using the attributes service is adding or replacing individual attribute:

        HypermediaAttribute attribute = new HypermediaAttribute();
                attribute.setName("test_attribute");
                attribute.setValue("test_value");

        session
                        .attributesService()
                        .forOrganization("organization_1")
                        .forUser("jasperadmin")
                        .attribute("test_attribute")
                        .createOrUpdate(attribute)
                        .getEntity();

Deleting User Attributes

The delete() method of the attributes service removes attributes from the specified user. When attributes are removed, both the name and the value of the attribute are removed, not only the value. There are two syntaxes, the following one is for deleting multiple attributes or all attributes at once.

 session
                .attributesService()
                .forOrganization("organization_1")
                .forUser("jasperadmin")
                .attributes("test_attribute_1","test_attribute_2")
                .delete();

// or
 session
                .attributesService()
                .forOrganization("organization_1")
                .forUser("jasperadmin")
                .allAttributes()
                .delete();

The second syntax deletes a single attribute for the specified user:

session
                .attributesService()
                .forOrganization("organization_1")
                .forUser("jasperadmin")
                .attribute("attributeName")
                .delete();

Viewing Organization Attributes

The code below retrieves the list of attributes, if any, defined for the organization.

List<HypermediaAttribute> attributes = session
                .attributesService()
                .forOrganization("organization_1")
                .allAttributes()
                .get()
                .getEntity()
                .getProfileAttributes();

You can retrieve any specified attributes. In this case all you need is to define required attributes. See code snippet below:

List <HypermediaAttribute> attributes = session
        .attributesService()
        .forOrganization("organization_1")
        .attributes("number_of_employees", "number_of_units", "country_code")
        .get()
        .getEntity()
        .getAttributes();

Or to get a single organization attribute.

HypermediaAttribute attributes = session
        .attributesService()
        .forOrganization("organization_1")
        .attribute("industry")
        .get()
        .getEntity();

Setting Organization Attributes

Service allows you to create new organization attributes. See code below:

HypermediaAttributesListWrapper attributes = new HypermediaAttributesListWrapper();
attributes.setProfileAttributes(asList(
        new HypermediaAttribute(new ClientUserAttribute().setName("test_attribute_1").setValue("test_value_1")),
        new HypermediaAttribute(new ClientUserAttribute().setName("test_attribute_2").setValue("test_value_2"))));
                
OperationResult<HypermediaAttributesListWrapper> attributes = session
                .attributesService()
                .forOrganization("organization_1")
                .attributes(asList("test_attribute_1", "test_attribute_2")
                .createOrUpdate(serverAttributes);

If you want to replace all existing attributes with new ones:

OperationResult<HypermediaAttributesListWrapper> attributes = session
                .attributesService()
                .forOrganization("organization_1")
                .allAttributes()
                .createOrUpdate(serverAttributes);

Be careful with definition of attribute names because the server uses different strategies for creating or updating attributes depending on list of attribute names, list of attributes and existing attributes on the server (see section Setting User Attributes). Or to create a single organization attribute code below:

HypermediaAttribute attribute = new HypermediaAttribute(new ClientTenantAttribute().setName("industry").setValue("IT"));
OperationResult<HypermediaAttribute> retrieved = session
        .attributesService()
        .forOrganization("organization_1")
        .attribute("industry")
        .createOrUpdate(attribute);

Attribute name should not exist on the server and match with name field of attribute object, otherwise the attribute will be deleted.

Deleting Organization Attributes

You can also delete a single organization attribute.

OperationResult<HypermediaAttribute> operationResult = session
                .attributesService()
                .forOrganization("organization_1")
                .attribute("industry")
                .delete();

Or to delete list of attributes:

OperationResult<HypermediaAttributesListWrapper> operationResult = session
                .attributesService()
                .forOrganization(orgName)
                .attributes("number_of_employees", "country_code")
                .delete();

Viewing Server Attributes

We have also provided service to get server attributes. Code below return available server attributes.

List<HypermediaAttribute> attributes = session
        .attributesService()
        .allAttributes()
        .get()
        .getEntity()
        .getProfileAttributes();

Or you can specify any concrete attribute.

HypermediaAttribute entity = session
                .attributesService()
                .attribute("attribute_name")
                .get()
                .getEntity();

Setting Server Attributes

It is possible to create new server attributes.

HypermediaAttributesListWrapper serverAttributes = new HypermediaAttributesListWrapper();
        serverAttributes.setProfileAttributes(asList(
                new HypermediaAttribute(new ClientUserAttribute().setName("max_threads").setValue("512")),
                new HypermediaAttribute(new ClientUserAttribute().setName("admin_cell_phone").setValue("03"))));

OperationResult<HypermediaAttributesListWrapper> attributes = session
                .attributesService()
                .attributes("max_threads", "admin_cell_phone")
                .createOrUpdate(newServerAttributes);

If you want to replace all existing attributes with new ones:

OperationResult<HypermediaAttributesListWrapper> attributes = session
                .attributesService()
                .allAttributes()
                .createOrUpdate(serverAttributes);

Be careful with definition of attribute names because the server uses different strategies for creating or updating attributes depending on list of attribute names, list of attributes and existing attributes on the server (see section Setting User Attributes). To create a single server attribute:

		HypermediaAttribute attribute = new HypermediaAttribute(new
		     ClientUserAttribute().setName("latency").setValue("5700"));

       session
                .attributesService()
                .attribute("latency")
                .createOrUpdate(attribute);

Attribute name should not exist on the server and match with name field of attribute object, otherwise the attribute will be deleted.

Deleting Server Attributes

You can delete all server attributes.

        session
                .attributesService()
                .allAttributes()
                .delete()
                .getEntity();

a single server attribute.

        session
                .attributesService()
                .attribute("latency")
                .delete();

Or any specified attributes.

session
                .attributesService()
                .attributes("max_threads", "admin_cell_phone")
                .delete();

Getting attributes permissions

Since 6.1 version of JasperReports Server you can obtain attributes with permissions using additional parameter setIncludePermissions():

 HypermediaAttribute entity = session
                 .attributesService()
                 .attribute("attribute_name")
                 .setIncludePermissions(true)
                 .get()
                 .getEntity();

Pay attention, the setting setIncludePermission() specify only the server response format, you can not set any permissions with this setting.

Searching Attributes

To get full list of attributes with specified parameters use the next code:

        session
            .attributesService()
            .allAttributes()
            .parameter(AttributesSearchParameter.HOLDER, "/")
            .parameter(AttributesSearchParameter.GROUP, AttributesGroupParameter.AWS)
            .parameter(AttributesSearchParameter.OFFSET, 20)
            .parameter(AttributesSearchParameter.INCLUDE_INHERITED, Boolean.TRUE)
            .search();
    HypermediaAttributesListWrapper attributes = operationResult.getEntity();

Supported parameters are: holder - represent the target holder, attributes should be fetched from; group - attribute group; custom - custom attributes(doesn't affect on server); log4j - logger specific attributes; mondrian - server attributes that make affect on Mondrian engine; aws - aws specific server attributes; jdbc - jdbc drivers specific attributes; adhoc - adhoc specific attributes; ji - profiling attributes; customServerSettings - updated server settings(changed log4j, mondrian, aws, jdbc, adhoc, ji server setting). recursive - flag indicates if attributes will be fetched also from lower level; includeInherited - flag indicates if search should include also higher level attributes, relatively to target holder; offset - pagination, start index for requested pate; limit - pagination, resources count per page.

You can also specified names of attributes:

        session
            .attributesService()
            .attributes("attrName1", "attrName2")
            .parameter(AttributesSearchParameter.HOLDER, "/")
            .parameter(AttributesSearchParameter.GROUP, AttributesGroupParameter.CUSTOM)
            .parameter(AttributesSearchParameter.OFFSET, 20)
            .parameter(AttributesSearchParameter.INCLUDE_INHERITED, Boolean.TRUE)
            .search();
    HypermediaAttributesListWrapper attributes = operationResult.getEntity();

Notice, for root 'HOLDERis/, for organization - organizationId`, for user in organization - 'organizationId/userName'. To specify the holder you can use the existing API:

        session
            .attributesService()
            .forOrganization("/")
            .forUser("jasperadmin")
            .attributes("attrName1", "attrName2")
            .parameter(AttributesSearchParameter.GROUP, AttributesGroupParameter.CUSTOM)
            .parameter(AttributesSearchParameter.OFFSET, 20)
            .parameter(AttributesSearchParameter.INCLUDE_INHERITED, Boolean.TRUE)
            .search();
    HypermediaAttributesListWrapper attributes = operationResult.getEntity();

Getting attributes permissions

Since 6.1 version of JaspersoftReportServer you can obtain attributes with permissions using additional parameter setIncludePermissions():

 HypermediaAttribute entity = session
                 .attributesService()
                 .attribute("attribute_name")
                 .setIncludePermissions(true)
                 .get()
                 .getEntity();

Pay attention, the setting setIncludePermission() specify only the server response format, you can not set any permissions with this setting.

The Roles Service

It provides similar methods that allow you to list, view, create, modify, and delete roles. The new service provides improved search functionality, including user-based role searches. Because the role ID is used in the URL, this service can operate only on roles whose ID is less than 100 characters long and does not contain spaces or special symbols. Unlike resource IDs, the role ID is the role name and can be modified.

Searching for Roles

The allRoles() method searches for and lists role definitions. It has options to search for roles by name or by user (param() method) that belong to the role. If no search is specified, it returns all roles.

OperationResult<RolesListWrapper> operationResult =
        session
                .rolesService()
                .allRoles()
                .param(RolesParameter.USER, "jasperadmin")
                .get();

RolesListWrapper rolesListWrapper = operationResult.getEntity();

Viewing a Role

The rolename() method with a role ID retrieves a single role descriptor containing the role properties.

OperationResult<ClientRole> operationResult =
        session
                .rolesService()
                .rolename("ROLE_ADMINISTRATOR")
                .get();

ClientRole role = operationResult.getEntity();

Creating a Role

To create a role, send the request via createOrUpdate() method to the roles service with the intended role ID (name) specified in the URL. Roles do not have any properties to specify other than the role ID, but the request must include a descriptor that can be empty.

ClientRole role = new ClientRole()
        .setName("ROLE_HELLO");

OperationResult<ClientRole> operationResult =
        session
                .rolesService()
                .rolename(role.getName())
                .createOrUpdate(role);

Response response = operationResult.getResponse();

Modifying a Role

To change the name of a role, send a request via createOrUpdate() to the roles service and specify the new name in the role descriptor. The only property of a role that you can modify is the role’s name. After the update, all members of the role are members of the new role name, and all permissions associated with the old role name are updated to the new role name.

ClientRole roleHello = new ClientRole()
        .setName("ROLE_HELLO_HELLO");

OperationResult<ClientRole> operationResult =
       session
                .rolesService()
                .rolename("ROLE_HELLO")
                .createOrUpdate(roleHello);

Response response = operationResult.getResponse();

Setting Role Membership

To assign role membership to a user, set the roles property on the user account with the PUT method of the rest_ v2/users service. For details, see section creating a user.

Deleting a Role

To delete a role, send the DELETE method and specify the role ID (name) in the URL. When this method is successful, the role is permanently deleted.

OperationResult<ClientRole> operationResult =
        session
                .rolesService()
                .rolename("ROLE_HELLO")
                .delete();
Response response = operationResult.getResponse();

Settings Service

======================

The Settings service allows you to get server specific settings, required by UI to work with the server in sync. There can be formats and patterns, modes for some modules etc.

To get settings, use the getEntity() method and specify the group of settings in the group() method and class of entity as shown below. The method getEntity() returns instance of specified class:

final Map settings = session
                .settingsService()
                    .settings()
                        .group(group, Map.class)
                            .getEntity();

Please notice, you can get settings of user’s time zones in this way as List only:

final List settings = session
        .settingsService()
        .settings()
        .group("userTimeZones", List.class)
        .getEntity();

Supported groups of settings are:

1. “request”. Settings related to current AJAX request configuration. Returned settings are: maxInactiveInterval, contextPath;

2. “dataSourcePatterns”. Validation patterns for data source UI. Returned settings are: dbHost, dbPort, dbPort, dbName, sName, driverType, schemaName, informixServerName, dynamicUrlPartPattern;

3. “userTimeZones”. Time zones of current user. Returned settings are pairs of code and description of time zone;

4. “globalConfiguration”. AWS specific settings. Returned settings are : paginatorItemsPerPage, paginatorPagesRange, reportLevelConfigurable, paginationForSinglePageReport, calendarInputJsp, userItemsPerPage, roleItemsPerPage, tenantItemsPerPage, userNameNotSupportedSymbols, roleNameNotSupportedSymbols, userNameSeparator, defaultRole, passwordMask, viewReportsFilterList, outputFolderFilterList, outputFolderFilterPatterns, tenantNameNotSupportedSymbols, tenantIdNotSupportedSymbols, resourceIdNotSupportedSymbols, publicFolderUri, themeDefaultName, themeFolderName, themeServletPrefix, dateFormat, currentYearDateFormat, timestampFormat, timeFormat, entitiesPerPage, tempFolderUri, organizationsFolderUri, jdbcDriversFolderUri, emailRegExpPattern, enableSaveToHostFS, allFileResourceTypes, dataSourceTypes;

5. “awsSettings”. AWS specific settings. Returned settings are: productTypeIsEc2, isEc2Instance, productTypeIsJrsAmi, awsRegions, productTypeIsMpAmi, suppressEc2CredentialsWarnings;

6. “decimalFormatSymbols”. Response is locale dependent;

7. “dateTimeSettings”. All settings related to client date-time formatting. Response is locale dependent;

8. “dashboardSettings”. Settings depend on configuration of Jaspersoft server;

9. “inputControls”. Different settings for input controls. Configuration of settings depend on configuration of Jaspersoft server;

10. “metadata”. Configuration of settings depends on configuration of Jaspersoft server;

11. “adhocview”. Different configuration dictionary values and lists for ad hoc. Configuration of settings depends on configuration of Jaspersoft server.

There is another way to get settings using specified methods for groups of settings that return specific object of settings:

Final RequestSettings settings = session
              .settingsService()
               .settings()
               .ofRequestGroup()
               .getEntity();

Please note, you should use List interface to get user’s time zones setting in this way:

final List<UserTimeZone> settings = session
        .settingsService()
        .settings()
        .ofUserTimeZonesGroup()
        .getEntity();

Or you can get List of specified DTO for user’s time zones using GenericType class:

final List<UserTimeZone> settings = session
        .settingsService()
        .settings()
        .group("userTimeZones", new GenericType<List<UserTimeZone>>() {})
        .getEntity();

Supported specified methods are:

OperationResult<RequestSettings> ofRequestGroup();
OperationResult<DataSourcePatternsSettings> ofDataSourcePatternsGroup();
OperationResult<List<UserTimeZone>> ofUserTimeZonesGroup();
OperationResult<AwsSettings> ofAwsGroup();
OperationResult<DecimalFormatSymbolsSettings> ofDecimalFormatSymbolsGroup();
OperationResult<DashboardSettings> ofDashboardGroup();
OperationResult<GlobalConfigurationSettings> ofGlobalConfigurationGroup();
OperationResult<DateTimeSettings> ofDateTimeGroup();
OperationResult<InputControlsSettings> ofInputControlsGroup();

Resources Service

This service provides consistent handling of resource descriptors for all repository resource types. The service has two formats.

• Using search parameters to find resources
• Using a repository URI to access resource descriptors and file contents

Searching the Repository

The resources service, accessed by the resources() method, is used to search the repository. The various parameters let you refine the search and specify how you receive search results. Search results are limited to the resources the session user has at least read access to.

OperationResult<ClientResourceListWrapper> result = session
        .resourcesService()
        .resources()
        .parameter(ResourceSearchParameter.FOLDER_URI, "/reports/samples")
        .parameter(ResourceSearchParameter.LIMIT, "5")
        .search();
ClientResourceListWrapper resourceListWrapper = result.getEntity();

The result of a search is a set of descriptors (ClientResourceLookup) showing the common attributes of each resource, including the type of the resource.

Parameters

Search Parameter	Value passed
ResourceSearchParameter.Q	String to find in names and descriptions
ResourceSearchParameter.FOLDER_URI	URI of a folder to search. Defaults to top level folder "/"
ResourceSearchParameter.RECURSIVE	Optional. true (default)/false. Search given folder and sub folders. false: Only search given folder
ResourceSearchParameter.TYPE	Optional. The type of resource - "resourceType in resourceDescriptors" - to search. See JasperReports Server REST documentation for the allowable types. Invalid types are ignored. Multiple types can be added to the one search.
ResourceSearchParameter.ACCESS_TYPE	Optional. Filters the results by whether the resources were "viewed" or "modified" by the session user.
ResourceSearchParameter.SHOW_HIDDEN_ITEMS	Optional. true/false. Default: false. Results include nested local resources (in _files) as if they were in the repository.
ResourceSearchParameter.SORT_BY	Optional. Sort by: uri, label, description, type, creationDate, updateDate, or, based on access events, popularity or accessTime. Default: results are sorted alphabetically by label.
ResourceSearchParameter.LIMIT	Optional. Maximum number of results to return or limit in a page. Default 100. Set to 0 to get all results. See Pagination below.
ResourceSearchParameter.OFFSET	Optional. Positive integer. Starting point to retrieve a page of results. See Pagination below.
ResourceSearchParameter.FORCE_TOTAL_COUNT	Optional. true/false. Force Total-Count in all response headers. Otherwise Total-Count is only returned on the first request. See Pagination below.
ResourceSearchParameter.FORCE_FULL_PAGE	Optional. true/false. Force each page to return the LIMIT number of results. See Pagination below.

Pagination

The search() method will return a "page" of results. The default page size is 100, overridden by the LIMIT parameter.

To get all results in one request, add: parameter(ResourceSearchParameter.LIMIT, "0") or use the searchAll() method instead of search(). searchAll() uses default pagination to efficiently get the search results.

If ResourceSearchParameter.FORCE_FULL_PAGE is not set, even if LIMIT is, the number of results in each page will vary because of security filtering. Also, because of security filtering, the Total-Count header value is not reliable.

So to paginate:

1. On initial request

• set the LIMIT or use the default of 100
• FORCE_FULL_PAGE can be set but is slow.

2. Search and process the results.

3. If FORCE_FULL_PAGE is set and the results are less than the LIMIT, then there are no more results.

4. Otherwise

   • Set the OFFSET in the next search request to be (Start-Index + Result-Count) from the response headers.
   • Search and process again.

5. Continue until you get a 204 No Content response.

Viewing Resource Details

Use the resource() method and a resource URI with details() method to request the resource's complete descriptor.

OperationResult<ClientResource> result = session
        .resourcesService()
        .resource("/properties/GlobalPropertiesList")
        .details();

Downloading File Resources

There are two operations on file resources:

• Viewing the file resource details to determine the file format
• Downloading the binary file contents

To view the file resource details, specify the URL of the file in resource() method and use the code form Viewing Resource Details section. To download file binary content, specify the URL of the file in resource() method and use the code below

OperationResult<InputStream> result = session
        .resourcesService()
        .resource("/themes/default/buttons.css")
        .downloadBinary();

InputStream inputStream = result.getEntity();

To get file MIME type yo can get Content-Type header from the Response instance.

Creating a Resource

The createNew() and createOrUpdate() methods offer alternative ways to create resources. Both take a resource descriptor but each handles the URL differently. With the createNew() method, specify a folder in the URL, and the new resource ID is created automatically from the label attribute in its descriptor. With the createOrUpdate() method, specify a unique new resource ID as part of the URL in resource() method.

ClientFolder folder = new ClientFolder();
String parentUri = "/reports";
folder
        .setUri("/reports/testFolder")
        .setLabel("Test Folder")
        .setDescription("Test folder description")
        .setPermissionMask(0)
        .setCreationDate("2014-01-24 16:27:47")
        .setUpdateDate("2014-01-24 16:27:47")
        .setVersion(0);

OperationResult<ClientResource> session
        .resourcesService()
        .resource(folder.getUri())
        .createOrUpdate(folder);
//OR
OperationResult<ClientResource> session
        .resourcesService()
        .resource(parenUri)
        .createNew(folder);

Modifying a Resource

Use the createOrUpdate() method above to overwrite an entire resource. Specify the path of the target resource in the resource() method and specify resource of the same type. Use parameter(ResourceServiceParameter.OVERWRITE, "true") to replace a resource of a different type. The resource descriptor must completely describe the updated resource, not use individual fields. The descriptor must also use only references for nested resources, not other resources expanded inline. You can update the local resources using the hidden folder _file. The patchResource() method updates individual descriptor fields on the target resource. It also accept expressions that modify the descriptor in the Spring Expression Language. This expression language lets you easily modify the structure and values of descriptors.

PatchDescriptor patchDescriptor = new PatchDescriptor();
patchDescriptor.setVersion(0);
patchDescriptor.field("label", "Patch Label");

OperationResult<ClientFolder> result = session
        .resourcesService()
        .resource("/reports/testFolder")
        .patchResource(ClientFolder.class, patchDescriptor);

Note that you must explicitly set the type of resource to update because of server issue.

Copying a Resource

To copy a resource, specify in copyFrom() method its URI and in resource() method URI of destination location.

OperationResult<ClientResource> result = session
        .resourcesService()
        .resource("/reports")
        .copyFrom("/datasources/testFolder");

Moving a Resource

To move a resource, specify in moveFrom() method its URI and in resource() method URI of destination location.

OperationResult<ClientResource> result = session
        .resourcesService()
        .resource("/datasources")
        .moveFrom("/reports/testFolder");

Creating and Updating File and InputStream Resources

You must specify the MIME type that corresponds with the desired file type, you can take it from ClientFile.FileType enumeration.

// Using multi-part form
OperationResult<ClientFile> result = session
        .resourcesService()
        .resource("/reports/testFolder/test.png")
        .uploadFile(imageFile, ClientFile.FileType.img, "fileName", "fileDescription");
        
// OR
// Using body post
OperationResult result = session
    .resourcesService()
    .resource("/reports/testFolder/test.png")
    .createContentFile(tempFile, FileType.png, file.getLabel(), file.getDescription());

OperationResult result = session
    .resourcesService()
    .resource("/reports/testFolder/test.jrxml")
    .createContentInputStream(inputStream, FileType.jrxml, file.getLabel(), file.getDescription());

OperationResult result = session
    .resourcesService()
    .resource("/reports/testFolder/test.png")
    .updateContentFile(tempFile, FileType.png, file.getLabel(), file.getDescription());

OperationResult result = session
    .resourcesService()
    .resource("/reports/testFolder/test.jrxml")
    .updateContentInputStream(inputStream, FileType.jrxml, file.getLabel(), file.getDescription());

Uploading SemanticLayerDataSource

RestClient also supports a way to create complex resources and their nested resources in a single multipart request. One of such resources is SemanticLayerDataSource.

ClientSemanticLayerDataSource domainEntity = session
        .resourcesService()
            .resource(domain)
                .withBundle(defBundle, newDefaultBundle)
                .withBundle(enUSBundle, newEnUsBundle)
                .withSecurityFile(securityFile, securityFile)
                .withSchema(schemaFile, schema)
            .inFolder("/my/new/folder/")
                .create()
                    .entity();        

Uploading MondrianConnection

REST Client allows you to create MondrianConnection Resource with mondrian schema XML file. You can specify the folder in which the resource will be placed. Provided API allows to add XML schema as String or InputStream.

ClientMondrianConnection connection = session
    .resourcesService()
        .resource(mondrianConnection)
            .withMondrianSchema(schema, schemaRef)
        .createInFolder("my/olap/folder")
            .entity();

Uploading SecureMondrianConnection

To upload SecureMondrianConnection Resource with a bunch of support files such as Mondrian schema XML file and AccessGrantSchemas files you can use our new API

ClientSecureMondrianConnection entity = session.resourcesService()
    .resource(secureMondrianConnection)
        .withMondrianSchema(mondrianSchema)
        .withAccessGrantSchemas(Arrays.asList(accessGrantSchema))
    .createInFolder("/my/new/folder/")
        .entity();

Uploading ReportUnit

To upload ReportUnit resource to the server you can use next API, which allows you to do it in a very simple way. You can add JRXML file and a bunch of various files like images and others as well.

ClientReportUnit entity = session.resourcesService()
    .resource(reportUnit)
        .withJrxml(file, descriptor)
        .withNewFile(imgFile, "myFile", imgDescriptor)        
            .createInFolder("/my/new/folder/")
                .entity();

Deleting Resources

You can delete resources in two ways, one for single resources and one for multiple resources. To delete multiple resources at once, specify multiple URIs with the ResourceSearchParameter.RESOURCE_URI parameter.

//multiple
OperationResult result = session
        .resourcesService()
        .resources()
        .parameter(ResourceSearchParameter.RESOURCE_URI, "/some/resource/uri/1")
        .parameter(ResourceSearchParameter.RESOURCE_URI, "/some/resource/uri/2")
        .delete();
//OR
//single
OperationResult result = session
        .resourcesService()
        .resource("/reports/testFolder")
        .delete();

The Permissions Service

In the permissions service, the syntax is expanded so that you can specify the resource, the recipient (user name or role name) and the permission value within the URL. This makes it simpler to set permissions because you don’t need to send a resource descriptor to describe the permissions. In order to set, modify, or delete permissions, you must use credentials or login with a user that has “administer” permissions on the target resource. Because a permission can apply to either a user or a role, the permissions service uses the concept of a “recipient”. A recipient specifies whether the permission applies to a user or a role, and gives the ID of the user or role. There are two qualities of a permission:

• The assigned permission is one that is set explicitly for a given resource and a given user or role. Not all permissions are assigned, in which case the permission is inherited from the parent folder.
• The effective permission is the permission that is being enforced, whether it is assigned or inherited.

Viewing Multiple Permissions

OperationResult<RepositoryPermissionListWrapper> operationResult =
        session
                .permissionsService()
                .resource("/datasources")
                .get();

Viewing a Single Permission

Specify the recipient in the URL to see a specific assigned permission.

OperationResult<RepositoryPermission> operationResult =
        session
                .permissionsService()
                .resource("/datasources")
                .permissionRecipient(PermissionRecipient.ROLE, "ROLE_USER")
                .get();

RepositoryPermission permission = operationResult.getEntity();

Setting Multiple Permissions

The createNew() method assigns any number of permissions to any number of resources specified in the body of the request. All permissions must be newly assigned, and the request will fail if a recipient already has an assigned (not inherited) permission. Use the createOrUpdate() method to update assigned permissions. The createOrUpdate() method modifies exiting permissions (already assigned).

List<RepositoryPermission> permissionList = new ArrayList<RepositoryPermission>();
permissionList.add(new RepositoryPermission("/themes", "user:/joeuser", 30));

RepositoryPermissionListWrapper permissionListWrapper = new RepositoryPermissionListWrapper(permissionList);

OperationResult operationResult =
        session
                .permissionsService()
                .createNew(permissionListWrapper);

Response response = operationResult.getResponse();

Setting a Single Permission

The createNew() method accepts a single permission descriptor.

RepositoryPermission permission = new RepositoryPermission();
permission
        .setUri("/")
        .setRecipient("user:/joeuser")
        .setMask(PermissionMask.READ_WRITE_DELETE);

OperationResult operationResult =
        session
                .permissionsService()
                .createNew(permission);

Response response = operationResult.getResponse();

Deleting Permissions in Bulk

The delete() method removes all assigned permissions from the designated resource. After returning successfully, all effective permissions for the resource are inherited.

OperationResult operationResult =
        session
                .permissionsService()
                .resource("/themes")
                .delete();

Response response = operationResult.getResponse();

Deleting a Single Permission

Specify a recipient in the permissionRecipient() method and call the delete() method to remove only that permission.

OperationResult operationResult =
        session
                .permissionsService()
                .resource("/")
                .permissionRecipient(PermissionRecipient.USER, "joeuser")
                .delete();

Response response = operationResult.getResponse();

Jobs service

================== The jobs service provides the interface to schedule reports and manage scheduled reports (also called jobs). In addition, this service provides an API to scheduler features that were introduced in JasperReports Server 4.7, such as bulk updates, pausing jobs, FTP output and exclusion calendars.

Listing Report Jobs

Use the following method to list all jobs managed by the scheduler.

OperationResult<JobSummaryListWrapper> result = session
        .jobsService()
        .jobs()
        .get();

JobSummaryListWrapper jobSummaryListWrapper = result.getEntity();

The jobs are described in the JobSummary element.

Viewing a Job Definition

The following piece of code with a specific job ID specified in job() method retrieves the detailed information about that scheduled job.

OperationResult<Job> result = session
        .jobsService()
        .job(8600)
        .get();

Job job = result.getEntity();

This code returns a job element that gives the output, scheduling, and parameter details, if any, for the job.

Extended Job Search

The search() method is used for more advanced job searches. Some field of the jobsummary descriptor can be used directly as parameters, and fields of the job descriptor can also be used as search criteria. You can also control the pagination and sorting order of the reply.

Job criteria = new Job);
criteria.setLabel("updatedLabel");
criteria.setAlert(new JobAlert());

OperationResult<JobSummaryListWrapper> result = session
        .jobsService()
        .jobs()
        .parameter(JobsParameter.SEARCH_LABEL, "hello")
        .search(criteria);

JobSummaryListWrapper jobSummaryListWrapper = result.getEntity();

The criteria parameter lets you specify a search on fields in the job descriptor, such as output formats. Some fields may be specified in both the search parameter and in a dedicated parameter, for example label. In that case, the search specified in the parameter takes precedence. For example, you can search for all jobs that specify output format of PDF. The criteria to specify this field is:

List<String> outputFormats = new ArrayList<String>();
outputFormats.add("PDF");
OutputFormatsListWrapper wrapper = new OutputFormatsListWrapper(outputFormats);
JobExtension criteria = new JobExtension();
criteria.setOutputFormats(wrapper);

Currently the code is a little bit littered, in futere versions it will be eliminated.

Scheduling a Report

To schedule a report, create its job descriptor similar to the one returned by the job(id).get(); method, and use the scheduleReport() method of the jobs service. Specify the report being scheduled inside the job descriptor. You do not need to specify any job IDs in the descriptor, because the server will assign them.

job.setLabel("NewScheduledReport");
job.setDescription("blablabla");
JobSource source = job.getSource();
source.setReportUnitURI("/reports/samples/Employees");

OperationResult<Job> result = session
        .jobsService()
        .scheduleReport(job);

job = result.getEntity();

The body contains the job descriptor of the newly created job. It is similar to the one that was sent but now contains the jobID for the new job.

Viewing Job Status

The following method returns the current runtime state of a job:

OperationResult<JobState> result = session
        .jobsService()
        .job(8600)
        .state();

JobState jobState = result.getEntity();

Response contains the JobState status descriptor.

Editing a Job Definition

To modify an existing job definition, use the job(id).get() method to read its job descriptor, modify the descriptor as required, and use the update() method of the jobs service. The update() method replaces the definition of the job with the given job ID.

String label = "updatedLabel";
Long jobId = job.getId();
job.setLabel(label);

OperationResult<Job> result = session
        .jobsService()
        .job(jobId)
        .update(job);

Job job = result.getEntity();

Updating Jobs in Bulk

To update several jobs at once you should specify jobs IDs as parameters, and send a descriptor with filled fields to update.

Job jobDescriptor = new Job();
jobDescriptor.setDescription("Bulk update description");

OperationResult<JobIdListWrapper> result = session
        .jobsService()
        .jobs()
        .parameter(JobsParameter.JOB_ID, "8600")
        .parameter(JobsParameter.JOB_ID, "8601")
        .update(jobDescriptor);

The code above will update the description field of jobs with IDs 8600 and 8601.

Pausing Jobs

The following method pauses currently scheduled job execution. Pausing keeps the job schedule and all other details but prevents the job from running. It does not delete the job.

OperationResult<JobIdListWrapper> result = session
        .jobsService()
        .jobs()
        .parameter(JobsParameter.JOB_ID, "8600")
        .pause();

Resuming Jobs

Use the following method to resume any or all paused jobs in the scheduler. Resuming a job means that any defined trigger in the schedule that occurs after the time it is resumed will cause the report to run again. Missed schedule triggers that occur before the job is resumed are never run.

OperationResult<JobIdListWrapper> result = session
        .jobsService()
        .jobs()
        .parameter(JobsParameter.JOB_ID, "8600")
        .resume();

Restarting Failed Jobs

Use the following method to rerun failed jobs in the scheduler. For each job to be restarted, the scheduler creates an immediate single-run copy of job, to replace the one that failed. Therefore, all jobs listed in the request body will run once immediately after issuing this command. The single-run copies have a misfire policy set so that they do not trigger any further failures (MISFIRE_ INSTRUCTION_IGNORE_MISFIRE_POLICY). If the single-run copies fail themselves, no further attempts are made automatically.

OperationResult<JobIdListWrapper> result = session
        .jobsService()
        .jobs()
        .parameter(JobsParameter.JOB_ID, "8600")
        .restart();

Calendars service

The scheduler allows a job to be defined with a list of excluded days or times when you do not want the job to run. For example, if you have a report scheduled to run every business day, you want to exclude holidays that change every year. The list for excluded days and times is defined as a calendar, and there are various ways to define the calendar. The scheduler stores any number of exclusion calendars that you can reference by name. When scheduling a report, reference the name of the calendar to exclude, and the scheduler automatically calculates the correct days to trigger the report. The scheduler also allows you to update an exclusion calendar and update all of the report jobs that used it. Therefore, you can update the calendar of excluded holidays every year and not need to modify any report jobs.

Listing All Registered Calendar Names

The following method returns the list of all calendar names that were added to the scheduler.

OperationResult<CalendarNameListWrapper> result = session
        .jobsService()
        .calendars();  //OR .calendars(CalendarType.HOLIDAY); //to specify the desired calendar type

CalendarNameListWrapper calendarNameListWrapper = result.getEntity();

Viewing an Exclusion Calendar

The following method takes the name of an exclusion calendar and returns the definition of the calendar:

OperationResult<Calendar> result = session
        .jobsService()
        .calendar("testCalendar")
        .get();

Calendar jobCalendar = result.getEntity();

As a result we have common caledar descriptor ReportJobCalendar.

Adding or Updating an Exclusion Calendar

This method creates a named exclusion calendar that you can use when scheduling reports. If the calendar already exists, you have the option of replacing it and updating all the jobs that used it.

WeeklyCalendar calendar = new WeeklyCalendar();
calendar.setDescription("lalala");
calendar.setTimeZone("GMT+03:00");
calendar.setExcludeDaysFlags(new boolean[]{true, false, false, false, false, true, true});

OperationResult result = session
        .jobsService()
        .calendar("testCalendar")
        .createOrUpdate(calendar);

Unlike common ReportJobCalendar which we receive as result of GET operation here we need create the calendar instance of desired type and path it to the createOrUpdate() method.

Deleting an Exclusion Calendar

Use the following method to delete a calendar by name.

OperationResult result = session
        .jobsService()
        .calendar("testCalendar")
        .delete();

Export service

============= The export service works asynchronously: first you request the export with the desired options, then you monitor the state of the export, and finally you request the output file. You must be authenticated as the system admin (superuser)or jasperadmin for the export services.

OperationResult<State> operationResult =
        session
                .exportService()
                .newTask()
                .user("jasperadmin")
                .role("ROLE_USER")
                .parameter(ExportParameter.EVERYTHING)
                .create();

State state = operationResult.getEntity();

The export parameters you can specify are:

`everything `- export everything except audit data: all repository resources, permissions, report jobs, users, and roles. This option is equivalent to:--uris --repository-permissions --report-jobs --users --roles
(default value is false). 

`repository-permissions `- when this option is present, repository permissions are exported along with each exported folder and resource. This option should only be used in conjunction with uris (default value is false).

`role-users `- when this option is present, each role export triggers the export of all users belonging to the role. This option should only be used in conjunction with --roles (default value is false).

`include-access-events `- access events (date, time, and user name of last modification) are exported (default value is false).

`include-audit-events `- include audit data for all resources and users in the export (default value is false).
 
`include-monitoring-events `- include monitoring events (default value is false).

`include-attributes `- include attributes in export (default value is false).

`skip-attribute-values `- skip attributes values to be exported (default value is false).

`include-server-settings`	- include server settings in export(default value is false).

`skip-suborganizations `- if the parameter is set to true, the system will omit all the items(e.g. resources, user, roles, organizations) which belong to "sub organizations" even they are directly specified using corresponding options (default value is false).

`skip-dependent-resources `- skip dependent resources (domain, datasource etc.) to be exported (default value is false). 
//TODO task
Also you can specify:
`uris` - list of folder or resource URIs in the repository  to export.
`scheduledJobs` - list of repository report unit and folder URIs for which report unit jobs should be exported. For a folder URI, this option exports the scheduled jobs of all reports in the folder and all subfolders.	
`roles` - list of roles to export.
`users` - list of users to export.
`resourceTypes` - list of resource types, that will be included in export. If the parameter is null or empty then will include all resource types.
`organization` - identifier of organization to export together with its sub organizations. If it is specified it also will be the root organization, starting from it system will export all resources, users, roles e.t.c.

```java
        OperationResult<State> stateOperationResult = session
                .exportService()
                .newTask()
                .uri("/temp/supermartDomain")
                .user("jasperadmin")
                .role("ROLE_USER")
                .resourceTypes(asList("jdbcDataSource", "reportUnit", "file"))
                .parameter(ExportParameter.EVERYTHING)
                .create();

Checking the Export Task

After receiving the export ID, you can check the state of the export operation.

OperationResult<State> operationResult =
        session
                .exportService()
                .task(state.getId())
                .state();

State state = operationResult.getEntity();

The body of the response contains the current state of the export operation.

Fetching the Export Output

When the export state is ready, you can download the zip file containing the export catalog.

OperationResult<InputStream> operationResult1 =
        session
                .exportService()
                .task(state.getId())
                .fetch();

InputStream inputStream = operationResult1.getEntity();

Import service

Use the following service to upload a catalog as a zip file and import it with the given options. Specify options as arguments from com.jaspersoft.jasperserver.jaxrs.client.apiadapters.importexport.importservice.ImportParameter. Arguments that are omitted are assumed to be false. You must be authenticated as the system admin (superuser) or jasperadmin for the import service. Jaspersoft does not recommend uploading files greater than 2 gigabytes.

URL url = ImportService.class.getClassLoader().getResource("testExportArchive.zip");
OperationResult<State> operationResult =
        session
                .importService()
                .newTask()
                .parameter(ImportParameter.INCLUDE_ACCESS_EVENTS, true)
                .create(new File(url.toURI()));

State state = operationResult.getEntity();

Available parameters are: includeAccessEvents - access events (date, time, and user name of last modification) are exported (default value is false). includeAuditEvents - include audit data for all resources and users in the export (default value is false). update - resources in the catalog replace those in the repository if their URIs and typesmatch (default value is false). skipUserUpdate - when used with --update, users in the catalog are not imported or updated. Use this option to import catalogs without overwriting currently defined user (default value is false). includeMonitoringEvents - include monitoring events (default value is false). includeServerSettings - include server settings (default value is false). mergeOrganization - allows merging of exported organization/resource into organization with different identifier. In the case if it is false, then system will throw an exception, if exportedOrganizationId != organizationId_we_import_Into (default value is false). brokenDependencies - defines strategy with broken dependencies. Available values are - fail, skip, include (default value is fail).

Also you can set: brokenDependencies - defines strategy with broken dependencies. Available values are:

fail - server will give an error (errorCode=import.broken.dependencies) if import archive contain broken dependent resources.
skip - import will skip from import broken resources.
include - import will proceed with broken dependencies. In this case server will try to import broken dependent resources. a) In the case when in target environment there are already dependent resources import of target resource will be success, and resource will be skipped from import if there are no dependent resources to recover dependency chain.

parameters - list of import parameters. organization - organization identifier we import into.

Checking the Import Task

After receiving the import ID, you can check the state of the import operation.

OperationResult<State> operationResult =
        session
                .importService()
                .task(state.getId())
                .state();

State state = operationResult.getEntity();

Managing the Import task

To get import task metadata:

        OperationResult<State> operationResult = session
                .importService()
                .newTask()
                .parameter(ImportParameter.INCLUDE_ACCESS_EVENTS, true)
                .parameter(ImportParameter.UPDATE, true)
                .create(new File("\\import.zip"));
        State state = operationResult.getEntity();

        ImportTask task = session
                .importService()
                .task(state.getId())
                .getTask()
                .getEntity();

Also you can restart import task:

        ImportTask task = importService.
                task(state.getId())
                .restartTask(new ImportTask().setBrokenDependencies("false"))
                .getEntity();

DomainMetadata Service

The DomainMetadata Service gives access to the sets and items exposed by a Domain for use in Ad Hoc reports. Items are database fields exposed by the Domain, after all joins, filters, and calculated fields have been applied to the database tables selected in the Domain. Sets are groups of items, arranged by the Domain creator for use by report creators.

A limitation of the DomainMetadata Service only allows it to operate on Domains with a single data island. A data island is a group of fields that are all related by joins between the database tables in the Domain. Fields that belong to tables that are not joined in the Domain belong to separate data islands.

The following code retrieves metadata of Domain.

DomainMetaData domainMetaData = session.domainService()
        .domainMetadata("/Foodmart_Sales")
        .retrieve()
        .getEntity();

Thumbnail Search Service

This service is used for requesting a thumbnail image of an existing resource. You can get a single resource. See code below.

InputStream entity = session.thumbnailsService()
        .thumbnail()
        .report("/public/Samples/Reports/08g.UnitSalesDetailReport")
        .defaultAllowed(true)
        .get()
        .getEntity();

Or to get multiple resources thumbnails.

List<ResourceThumbnail> entity = session.thumbnailsService()
        .thumbnails()
        .reports(asList("/public/Samples/Reports/08g.UnitSalesDetailReport", 
                        "/public/Samples/Reports/11g.SalesByMonthReport"))
        .defaultAllowed(true)
        .get()
        .getEntity()
        .getThumbnails();

By default you obtain multiple resources using POST HTTP method, but you can switch to GET method using requestMethod(RequestMethod.GET) method:

List<ResourceThumbnail> entity = session.thumbnailsService()
                .thumbnails()
                .reports(asList("/public/Samples/Reports/08g.UnitSalesDetailReport",
                        "/public/Samples/Reports/11g.SalesByMonthReport"))
                .defaultAllowed(true)
                .requestMethod(RequestMethod.GET)
                .get()
                .getEntity()
                .getThumbnails();
                ```
Please notice that ResourceThumbnail class (DTO) contains the content in Base64 string format (not InputStream).

# Diagnostic Service

The service is used to create, update, stop log collectors and get logs and data snapshots.
To create log collector use the code below:
```java
OperationResult<CollectorSettings> operationResult1 = session
                                                            .diagnosticService()
                                                            .forCollector(collector1)
                                                            .create();

collector1 = operationResult1.getEntity();

New collector gets ID and status "RUNNING" automatically. After creation you can get metadata of all collectors:

OperationResult<CollectorSettingsList> operationResult = session
                .diagnosticService()
                .allCollectors()
                .collectorsSettings();

CollectorSettingsList result = operationResult
                .getEntity();

or for single log collector:

OperationResult<CollectorSettings> operationResult = session
                .diagnosticService()
                .forCollector(collector1.getId())
                .collectorSettings();

CollectorSettings result = operationResult
                .getEntity();

You can change collector's metadata or stop it using .updateCollectorSettings() method:

PatchDescriptor patchDescriptor = new PatchDescriptor();
List<PatchItem> items = new ArrayList<PatchItem>();
items.add(new PatchItem().setField("status").setValue("STOPPED"));
patchDescriptor.setItems(items);

OperationResult<CollectorSettings> operationResult = session
                .diagnosticService()
                .forCollector(collector1)
                .updateCollectorSettings(patchDescriptor);

CollectorSettings result = operationResult
                .getEntity();

Using similar method for batch operation you can update the same field of all collectors:

OperationResult<CollectorSettingsList> operationResult = session
                .diagnosticService()
                .allCollectors()
                .updateCollectorsSettings(patchDescriptor);
CollectorSettingsList result = operationResult
                .getEntity();

Also you can update whole collector:

collector1.setStatus("STOPPED");

OperationResult<CollectorSettings> operationResult = session
                .diagnosticService()
                .forCollector(collector1)
                .updateCollectorSettings(collector1);

CollectorSettings result = operationResult
                .getEntity();

To get collectors' content use code below:

OperationResult<InputStream> operationResult = session
                .diagnosticService()
                .allCollectors()
                .collectorsContent();
                
         // or for single collector
          
OperationResult<InputStream> operationResult = session
                          .diagnosticService()
                          .forCollector(collector1)
                          .collectorContent();
          
InputStream result = operationResult
                          .getEntity();

Please notice, you should stop them previously using .updateCollectorSettings() methods. Stopping the collector will turn off logging and begin resource export (if "includeDataSnapshots" is true and resourceUri not empty). Once stopped, collectors can't be run again. When App Server (e.g. Tomcat) is restarted, all collectors must change to stopped state. Before getting collectors' content check them status with method .collectorsSettings().

Delete log collectors you can as single or as batch operation:

OperationResult<CollectorSettings> operationResult = session
                .diagnosticService()
                .forCollector(collector1)
                .delete();
                
OperationResult<CollectorSettingsList> operationResult = session
                                .diagnosticService()
                                .allCollectors()
                                .delete();

Query Executor Service

In addition to running reports, JasperReports Server exposes queries that you can run through the QueryExecutor service. For now the only resource that supports queries is a Domain.

The following code executes query and retrieves a result of execution as QueryResult entity.

QueryResult queryResult = session.queryExecutorService()
        .query(queryFromXmlFile, "/organizations/organization_1/Domains/Simple_Domain")
        .execute()
        .getEntity();

Server Information Service

Use the following service to verify the server information, the same as the About JasperReports Server link in the user interface. This can be done through an [anonymous session] (#anonymous-sessions).

OperationResult<ServerInfo> result = session
        .serverInfoService()
        .details();

ServerInfo serverInfo = result.getEntity();

The server returns a ServerInfo instance containing the requested information. You can access each value separately with the following code:

OperationResult<String> result = session
        .serverInfoService()
        .edition();
        //.version();
        //.licenseType();
        //.features();
        //.expiration();
        //.editionName();
        //.dateTimeFormatPattern();
        //.dateFormatPattern();
        //.build();

String edition = result.getEntity();

Bundles service

Use the bundles service to get bundles of internalization properties for particular or default user’s locale as JSON. This can be done through an [anonymous session] (#anonymous-sessions). By default, the service uses the default system locale where the application was stared. If a user specified locale at authentication, the service will use it as default locale. To get all bundles for particular locale(foe example, "de") different from default locale and locale specified at authentication use the code below:

final Map<String, Map<String, String>> bundles = session
        .bundlesService()
        .forLocale("de")
        .allBundles()
        .getEntity();

or specify locale as instance of java.util.Locale.class or as constant of this class:

final Map<String, Map<String, String>> bundles = session
        .bundlesService()
        .forLocale(Locale.US)
        .allBundles()
        .getEntity();
        
final Map<String, Map<String, String>> bundles = session
                .bundlesService()
                .forLocale(new Locale("en_US"))
                .allBundles()
                .getEntity();

Please notice, locale specified in .forLocale() method has the highest priority for the service. If you do not call.forLocale() method, you will get bundles for your default locale (locale specified at authentication or locale of system where the client was stared if the others were not specified):

final Map<String, Map<String, String>> bundles = session
        .bundlesService()
        .allBundles()
        .getEntity();

To get bundle by name you should specified locale in .forLocale() method and name of the bundle in .bundles() method:

final Map<String, String> bundle = session
        .bundlesService()
        .forLocale("en_US")
        .bundle("jasperserver_messages")
        .getEntity();

Asynchronous API

Each operation which requests server has its asynchronous brother which has same name with async prefix, e. g. get() -> asyncGet(). Each of these operations take a com.jaspersoft.jasperserver.jaxrs.client.core.Callback implementation with execute() method implemented. execute() takes an OperationResult instance as a parameter. The execute method is called when the response from server came. Each of these async operations returns com.jaspersoft.jasperserver.jaxrs.client.core.RequestExecution instance which gives you ability to cancel execution. Example:

RequestExecution requestExecution = session
        .organizationsService()
        .organizations()
        .parameter(OrganizationParameter.CREATE_DEFAULT_USERS, "false")
        .asyncCreate(new Organization().setAlias("asyncTestOrg"), new Callback<OperationResult<Organization>, Void>() {
            @Override
            public Void execute(OperationResult<Organization> data) {
                System.out.println(data.getEntity());
            }
        });

        requestExecution.cancel();

Possible issues

1. Deploying jrs-rest-client within a web application to any Application Server, e.g. JBoss, Glassfish, WebSphere etc. jrs-rest-client uses the implementation of JAX-RS API of version 2.0 and if your application server does not support this version you will get an error. To solve this problem, you will need to add to your application a deployment configuration specific for your application server to exclude modules with older JAX-RS API versions. An example of such a descriptor for JBoss AS is:

<jboss-deployment-structure>
    <deployment>
        <exclusions>

            <!-- Exclude JAVA EE of JBOSS (javax.ws..) => Add dependency javax.annotation -->
            <module name="javaee.api" />
            <!-- Exclude RestEasy conflict (javax.ws.rs.ext.RunDelegate) -->
            <module name="javax.ws.rs.api"/>
            <module name="org.codehaus.jackson.jackson-core-asl" />
            <module name="org.jboss.resteasy.resteasy-atom-provider" />
            <module name="org.jboss.resteasy.resteasy-cdi" />
            <module name="org.jboss.resteasy.resteasy-crypto" />
            <module name="org.jboss.resteasy.resteasy-jackson-provider" />
            <module name="org.jboss.resteasy.resteasy-jaxb-provider" />
            <module name="org.jboss.resteasy.resteasy-jaxrs" />
            <module name="org.jboss.resteasy.resteasy-jettison-provider" />
            <module name="org.jboss.resteasy.resteasy-jsapi" />
            <module name="org.jboss.resteasy.resteasy-json-p-provider" />
            <module name="org.jboss.resteasy.resteasy-multipart-provider" />
            <module name="org.jboss.resteasy.resteasy-validator-provider-11" />
            <module name="org.jboss.resteasy.resteasy-yaml-provider" />
        </exclusions>
    </deployment>
</jboss-deployment-structure>

Maven dependency to add jasperserver-rest-client to your application:

    <dependencies>
        <dependency>
            <groupId>com.jaspersoft</groupId>
            <artifactId>jrs-rest-java-client</artifactId>
            <version>6.4.0</version>
        </dependency>
    </dependencies>

    <repositories>
        
        <repository>
            <id>jaspersoft-clients-snapshots</id>
            <name>Jaspersoft clients snapshots</name>
            <url>https://jaspersoft.jfrog.io/jaspersoft/jaspersoft-clients-releases</url>
        </repository>

    </repositories>

#License

Copyright © 2005 - 2018 TIBCO. All rights reserved. http://www.jaspersoft.com.

Unless you have purchased a commercial license agreement from TIBCO, the following license terms apply:

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see http://www.gnu.org/licenses/.