<< View previous version | view page history | view next version >>
For those reports supported by QuickBuild, you can retrieve the report data via RESTful APIs. The supported reports included:
Report Category | Base URI |
---|---|
CheckStyle | /rest/checkstyle |
Cobertura | /rest/cobertura |
CPD | /rest/cpd |
EMMA | /rest/emma |
FindBugs | /rest/findbugs |
Fxcop | /rest/fxcop |
JUnit | /rest/junit |
MBUnit | /rest/mbunit |
MSTest | /rest/mstest |
NCover | /rest/ncover |
NUnit | /rest/nunit |
PMD | /rest/pmd |
TestNG | /rest/testng |
NOTE
All report related RESTful functions use http GET method.
Supported Functions
To get all supported functions, you may visit the URI as: \$baseURI/help, for example, all available RESTful functions for JUnit can be accessed by visiting the following URL:
http://quickbuild:8810/rest/junit/help
The response is in HTML format.
Retrieve the version of category
By visiting the URI $baseURI/version, you can get the current data version of the category.
http://quickbuild:8810/rest/junit/version
This will return current JUnit category data version.
Reports stored in the category
By visiting the URI $baseURI/reports, you can get all reports stored in QuickBuild system.
http://quickbuild:8810/rest/junit/reports
The return result is in XML format and looks like:
<list> <string>unprocessed</string> <string>tests</string> <string>testsuites</string> <string>packages</string> <string>stats</string> <string>agg_overview</string> <string>agg_stats</string> <string>tests_trends</string> </list>
Visit the report definition
If you want know the definition of a specified report, you may visit $baseURI/meta/{report_name}, for example, when visit:
http://quickbuild:8810/rest/junit/meta/stats
the definition of JUnit stats report will be returned in XML format:
<meta name="stats" group="STATISTICS"> <column name="ID" isKey="false" indexed="false" nullable="false" updatable="false" sqlType="BIGINT" dataType="ID"/> <column name="buildId" isKey="true" indexed="false" nullable="true" updatable="true" sqlType="BIGINT" dataType="ID"/> <column name="duration" isKey="false" indexed="false" nullable="true" updatable="true" sqlType="BIGINT" dataType="DURATION"/> <column name="tests" isKey="false" indexed="false" nullable="true" updatable="true" sqlType="INT" dataType="INTEGER"/> ... ... </meta>
Get all report sets / aggregations
In QuickBuild, the report data are stored by report sets or by aggregations. The report sets is specified in the publish step, and the aggregation name is specified in the aggregation definition.
Get the stats data of a specified build
By visiting ${