ktalarico

This demo was executed using TIBCO JasperReports® Server 7.2 and Postman v7.16.1. BackgroundDeploying report (jrxml) files to the Jasperserver repository can become time consuming using Jasperserver's user interface or even by publishing via Jaspersoft Studio. Imagine you've made a change to a report that lives in multiple organizations or you've made a change to multiple dashlets in a dashboard that lives in multiple organizations. You can spend hours deploying the reports to the server if you have several iterations of changes to test. By leveraging Jasper's REST API and Postman Collections, this amount of time can be reduced to seconds. Step by Step GuideIn this example, we will create three requests inside of a Postman collection. The first is a GET request that will retrieve the appropriate report descriptor for the report unit. We will store the descriptor in a variable which will be used in the second request to update the report unit. Note that the Jasper REST API requires a complete report descriptor in order to update the report unit. The second is a PUT request that allows us to update the report unit. We are simply sending the report descriptor we retrieved in the first request. The sole purpose of doing this is to trigger Jasperserver to modify the "updateDate" attribute of the report unit so that we have a record of when we modified the report. The third and final request will update the jrxml file. [toc]Before creating the collection, create an environment in Postman within which you will store variables.Click on the "Manage Environments" icon . For this example, our environment is called "Dev". Create a variable in the "Dev" environment called "reportDescriptor". Figure 1 - create Dev environment with variable Create a new collection in Postman, providing your Jasperserver credentials on the Authorization tab. Use type Basic Auth. In this example, our collection is called "Demo". Figure 2 - create a new collection Add a GET Request to the Demo collection. In this example, our request is called "Get demo report descriptor." Note that you can retrieve the report URL by viewing the Path in the report's properties in Jasperserver. Figure 3 - report path Define two headers in the request. The first should have a key = "Accept" with a value of "application/json". The second should have a key = "Content-Type" with a value of "application/repository.reportUnit+json". Figure 4 - Headers of GET demo report descriptor In the Pre-request Script of the request, clear the reportDescriptor variable. Figure 5 - Pre-request Script of Get demo report descriptor In the Tests section of the request, set the reportDescriptor variable equal to the response body. Figure 6 - Tests of Get demo report descriptor Click the "Send" button to test the GET request. It should respond with at status of 200 OK as well as the report descriptor that is now stored in a variable. Figure 7 - response status of Get demo report descriptor If you want to verify what is being stored in the reportDescriptor variable, click the "Environment Quick Look" icon Figure 8 - contents of reportDescriptor variable Add a PUT Request to the Demo collection. In this example, our request is called "Update demo report unit." Provide the following keys in the Headers tab. Figure 9 - Headers of Update demo report unit In the body, specify the reportDescriptor variable enclosed in double curly brackets. The Body format should be "raw". Figure 10 - Body of Update demo report unit In the Pre-request Script tab, get the reportDescriptor variable. Figure 11 - Pre-request Script of Update demo report unit Click the "Send" button to test the PUT request. It should respond with a status of 200 OK. It should also return an updated report descriptor. Note that the version changed from 4 to 5. This is why we must always perform a GET request to retrieve the appropriate descriptor prior to updating. Jasperserver will update the version number behind the scenes each time we send a PUT request. If we do not provide the correct version number, Jasper will respond with a "mismatched version" error. Figure 12 - response of Update demo report unit Add a final PUT Request to the Demo collection. In this example, our request is called "Update demo report jrxml." You will need to query the jasperserver database to get the appropriate URL as this cannot be obtained by browsing the repository. Figure 13 - SQL query to obtain approriate URL SELECT concat(jrf.uri,'/',jir.name) FROM JIResource jirLEFT JOIN JIResourceFolder jrf ON jrf.id = jir.parent_folder WHERE jir.resourceType = 'com.jaspersoft.jasperserver.api.metadata.common.domain.FileResource' AND jir.name LIKE '%Demo_Report%'[/code] Figure 14 - Headers of Update demo report jrxml The body type should be "binary". Click "Select File" and browse to the location of the jrxml file on your PC. Note that you should configure your Working Directory in Postman to point to the location where you store your jrxml files. Select File-Settings. In the General tab you will see a WORKING DIRECTORY section where you can specify the location. Figure 15 - Postman Working Directory Figure 16 - Body of Update demo report jrxml Click the "Send" button to test the request. It should respond with at status of 200 OK. It should also return an updated descriptor for the jrxml. Figure 17 - response of Update demo report jrxml Continue to add requests to your collection as needed. Run your collection by clicking the "Play" button to the right of your collection name then clicking "Run". Figure 18 - run the Demo collection The Collection Runner will open up a separate window. Click "Run Demo". Figure 19 - Collection Runner Figure 20 - Collection Runner summary Page: