Report Service (prs_rest) prod 1.0.0

ReportServiceService

Endpoint Metadata

The following methods are available on this endpoint:

generate

Generate a report from the parameters provided.
Example
rest/reports/report;path=%2Freport%2Frow;xmlUrl=tadtest2. xml;reportUrl=TAD_TEST.jrxml;format=pdf
If xmlUrl is set then the report will be filled with the data from the xmlUrl using the path parameter as the xpath expression to access data. Otherwise the jdbcUrl, jdbcDriver, jdbcUsername and jdbcPassword parameters are used to fill the report with data.
rest/reports/report;path=%2Freport%2Frow;xmlUrl=tadtest2. xml;reportUrl=TAD_TEST.jasper;format=pdf
If xmlUrl is set then the report will be filled with the data from the xmlUrl using the path parameter as the xpath expression to access data. Otherwise the jdbcUrl, jdbcDriver, jdbcUsername and jdbcPassword parameters are used to fill the report with data.

Input Parameters

name description
reportUrl The url of the jasper report xml
xmlUrl The url of the xml data for the report
xslUrl The url of the xsl stylesheet
path The xpath expression used to access data for the report
jdbcId The id of the jdbc connection details for the report
jdbcUrl The id of the jdbc connection details for the report
jdbcDriver The jdbc driver classname, e.g. org.postgresql.Driver
jdbcUsername The username of the jdbc connection for the report
jdbcPassword The password of the jdbc connection for the report
format The format for the xml data {"pdf", "html", "xml", "odt", "rtf", "xls", "pptx", "docx", "csv"}

Return Value

The generated report

generateReportJDBCId

Generate a report from a database specified by the details stored at jdbcId.

Input Parameters

name description
reportUrl (no documentation provided)
jdbcId (no documentation provided)

Return Value

(no documentation provided)

generateReportJDBCURLDriverUsernamePassword

Generate a report from the a database from the parameters provided.
Example
rest/reports/report/test.jrxml/jdbc/jdbc:postgresql:%2F%2Fpacific .niwa.co.nz:5432%2Ftest_tad/driver/org.postgresql.Driver/username/ taxa/password/www

Input Parameters

name description
reportUrl . NB: If you want a file from the standard environment dependent repository then do NOT put in a complete URL.
jdbcUrl (no documentation provided)
jdbcDriver (no documentation provided)
username (no documentation provided)
password (no documentation provided)

Return Value

(no documentation provided)

generateReportXMLXPath

Generate a report from the parameters provided.
Example
rest/reports/report/TAD_TEST.jrxml/xml/tadtest2. xml/xpath/%2Freport%2Frow

Input Parameters

name description
reportUrl The url of the jasper report xml NB: If you want a file from the standard environment dependent repository then do NOT put in a complete URL.
xmlUrl The url of the xml data for the report NB: If you want a file from the standard environment dependent repository then do NOT put in a complete URL.
path The xpath for the xml data

Return Value

The generated report

generateReportXMLXPathFormat

Generate a report from the parameters provided.
Example
rest/reports/report/TAD_TEST.jrxml/xml/tadtest2. xml/xpath/%2Freport%2Frow/format/pdf

Input Parameters

name description
reportUrl The url of the jasper report xml. NB: If you want a file from the standard environment dependent repository then do NOT put in a complete URL.
xmlUrl The url of the xml data for the report. NB: If you want a file from the standard environment dependent repository then do NOT put in a complete URL.
path The xpath for the xml data
format The format for the report

Return Value

The generated report

imageFromDirectoryImageName

Return an image created while generating a html report.
rest/reports/images/icon.png

Input Parameters

name description
directory (no documentation provided)
imageName (no documentation provided)

Return Value

(no documentation provided)

imageFromDirectoryImageNameXMLXPathFormat

Return an image created while generating a html report.
rest/reports/report/TAD_TEST.jrxml/xml/tadtest2.xml/xpath/%2Freport%2Frow/ format/images/icon.png

Input Parameters

name description
directory (no documentation provided)
imageName (no documentation provided)

Return Value

(no documentation provided)

imageFromImageName

Return an image created while generating a html report.
rest/reports/images/icon.png

Input Parameters

name description
imageName (no documentation provided)

Return Value

(no documentation provided)

version

Return the version of the service.
Example
rest/reports/version

Return Value

The version of the service.