Using the RQM REST API

NOTE: The XML to CSV conversion is beyond the scope of an IBM support case.

• Download a REST Client for your browser. A web search for REST Client should return a few choices such as RESTClient for Firefox and Restlet for Chrome. Another option is to download the RQM URL Utility from the All Downloads section of any RQM version on jazz.net
• The test script feed can be used to download up to 512 test scripts per page of XML with an HTTP GET using the REST Client. The number of test scripts per page of XML is dependent on the value of the  Max Feed Entries/Page parameter in RQM Administration > Advanced Properties >  RQM Integration Component. The default value is 50. 

• The test script feed URL documented here https://jazz.net/wiki/bin/view/Main/RqmApi#feedUrl_for_interaction_with_a_f will be used with the abbreviate parameter documented here https://jazz.net/wiki/bin/view/Main/RqmApi#abbreviate to ensure that the test script steps are include in the feed.

• Below is an example test script feed using abbreviate=false to return test scripts steps in the XML.  Server, port and context root are part of the RQM public URI. "RQMProject" is the RQM Project area alias which can be found in the project feed.

test script feed URL:

https://<server>:<port>/<context root>/service/com.ibm.rqm.integration.service.IIntegrationService/resources/RQMProject/testscript/?abbreviate=false

project feed URL to get project alias:

https://<server>:<port>/<context root>/service/com.ibm.rqm.integration.service.IIntegrationService/projects

• The REST client is now used for an HTTP GET on the test script feed URL. The REST client should provide a way to add a custom HTTP Header and this is required before the GET is preformed. The header name "accept" with value "txt/xml" should be be added first. Here is an example in a Firefox REST client

•  The REST client will look similar to the screen shots above with an option to GET for the HTTP method and a button to send the test script feed
• The XML returned from the GET on the test script feed with abbreviate=false will include the description and expected result for each step. This snippet shows 2 steps and their description/expected result:

•  If the feed requires multiple pages of XML those pages will be listed at the top of the feed like this:

• The larger the Max Feed Entries/Page noted above the few pages will have to be retrieved to get all test scripts 
• Finally the XML can be parsed and converted to CSV with a code that is not provided by IBM customer support. 

Using Report Builder with Lifecyle Query Engine

The Jazz Report Service (JRS) with Report Builder and Lifecyle Query (LQE) engine as the data source provides another simple way to get test script steps for a large number of manual test scripts. LQE is required as the data source because not all manual test script steps are stored in the data warehouse, only steps linked to a defect or requirement. Below is basic example report that can be exported to Microsoft Excel format. 

•  From Report Builder "Choose a Report Type" select  Lifecycle Query Engine if the project is not enable for configuration management or Lifecyle Query Engine scoped by a configuration if the project(s) is enabled for configuration management 

•  When selecting the artifact type use QM Test Script

•  Here is the trace relationship for this basic example report:

• Here is the report output showing the test script ID and each step:

•  Select the Export drop-down menu and export to Micrsoft Excel format