Demonstration/Troubleshooting

To demonstrate and/or troubleshoot the XLReporter REST API, in the _rest subfolder of the XLReporter installation folder is the Postman JSON collection XLRAPI.postman_collection.json. This collection provides the syntax for the methods provided.

This requires the Postman API platform to be downloaded and installed. If this is being used to troubleshoot, please install Postman on the same machine that you are trying to access the XLReporter REST API from to verify connectivity.

Once installed, import the collection into Postman.

Select the XLRAPI collection on the left side. On the right, select the Pre-request Script tab.

Update the values for server_ip and server_port to match what you have set up for XLReporter.

On the left, select login and on the right, select the Pre-request Script tab.

If user accounts are enabled in the project, update the values for user and guest for a valid user account.

Click the Send button in the upper right to send the login request.

If successful, the Response section will have the token to submit with all other requests. Highlight and copy the token value.

Return back to the XLRAPI Pre-request Script and paste in the token value.

On the left, select templates and on the right, click the Submit button. The Response should contain a list of templates from the project that have no parameters required. Highlight and copy the name of a template that you would like to generate a report for.

On the left, select report and on the right, select the Pre-request Script tab. For template, paste in the name you copied from the previous step. If you would like to, change the type to any supported type and size to any supported size. Click Send to generate the report.

Depending on the format and what is set up on your system, the report may appear in the response. Otherwise, you can save the response out and then open the saved file to view the report.

Once you are done demonstrating and/or troubleshooting, select logout on the left and click Send to log out of the session and free up the client license.