REST API: Reports

Methods

getReportForm
downloadZippedHtmlReport
downloadPdfReport
downloadXmlReport
downloadExcelReport
downloadWordReport

output = CApiXStudioWeb_Common.downloadZippedHtmlReport(session, response, request.getParameter("treeType"), request.getParameter("nodeType"), request.getParameter("nodeId"), request.getParameter("reportType"), request.getParameter("reportStyle"), request.getParameter("connectorIndex"));
TypeVer.Command parameterParameters
Getters
GET6+ getReportForm treeType=<treeType>
nodeType=<nodeType>
(opt.) fileExtension=<fileExtension>
Example of success:

Note:
If the fileExtension parameter is not provided, PDF is the format by default.
GET6+downloadZippedHtmlReport treeType=<treeType>
nodeType=<nodeType>
nodeId=<id>
reportType=<reportType>
(i.e. "Complete_with_stats")
reportStyle=<reportStyle>
(i.e. "XQual")
(opt.) connectorIndex=<index>
Content of the PDF report is passed in the response body (with a application/zip mime-type)
Example of success:

Example of failure:
GET3.2+downloadPdfReport treeType=<treeType>
nodeType=<nodeType>
nodeId=<id>
reportType=<reportType>
(i.e. "Complete_with_stats")
reportStyle=<reportStyle>
(i.e. "XQual")
(opt.) connectorIndex=<index>
Content of the PDF report is passed in the response body (with a application/pdf mime-type)
Example of success:

Example of failure:
Note:
The server will need a graphical environment to generate PDF report.
On headless systems, such as production linux servers you can use this as well but you will need to install a few libraries.

On each system it can be pretty different but on a headless ubuntu servers for instance you will need
to install those libs this way:

apt-get install libxrender1
apt-get install libfontconfig1
apt-get install libxext6
apt-get install libxmu6
apt-get install libxmuu1

If you get some errors during the generation of the PDF (server side), please check these notes
GET5+downloadXmlReport treeType=<treeType>
nodeType=<nodeType>
nodeId=<id>
reportType=<reportType>
(i.e. "Raw_data" or "JUnit" on sessions)
(opt.) connectorIndex=<index>
Content of the XML report is passed in the response body (with a application/xml mime-type)
Example of success:

Example of failure:
GET6+downloadExcelReport treeType=<treeType>
nodeType=<nodeType>
nodeId=<id>
reportType=<reportType>
(i.e. "Raw_data" or "Offline_manual_execution" on campaigns)
(opt.) connectorIndex=<index>
Content of the Excel file is passed in the response body (with a application/vnd.ms-excel mime-type)
Example of success:

Example of failure:
GET7+downloadWordReport treeType=<treeType>
nodeType=<nodeType>
nodeId=<id>
reportType=<reportType>
(i.e. "Raw_data" or "Offline_manual_execution" on campaigns)
(opt.) connectorIndex=<index>
Content of the Word file is passed in the response body (with a application/vnd.openxmlformats-officedocument.wordprocessingml.document mime-type)
Example of success:

Example of failure: