RQM REST - How to get more than 50 items in response?

Stefan Schmelz (57●1●18●21) | asked Mar 13 '13, 12:38 p.m.

We are creating a GET request for RQM using the following URL:

http://server/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/PROJEKTNAME/executionworkitem?fields=feed/entry/content/executionworkitem/(identifier|testplan[@href='TESTPLAN_IDENTIFIER'])

This returns a set of Executionworkitems for the project "PROJECTNAME" and testplan "TESTIDENTIFIER".

Unfortunately the returned XML only contains 50 ExecutionWorkitems as a maximum.
How can I configure the request to get the full amount of items (in our tested case 118)???

Thanks in advance for your answer.

6 answers

Most liked answers ↑|Newest answers|Oldest answers

permanent link

Ara Masrof (3.2k●1●5) | answered Mar 13 '13, 2:31 p.m.
JAZZ DEVELOPER

Stefan,

Take a quick look at the RQM API Reference:

https://jazz.net/wiki/bin/view/Main/RqmApi

Specifically under the Feeds heading:

Resources can be read (GET) individually (see <resourceUrl>) or as a feed of similar typed resources (see <feedUrl>).

The size of the feed page is variable. When a feed spans multiple pages, a link to the next page is provided in the current page (see ATOM paging specification). By default, the feed page size is set to 50 resources, but it can be modified to a maximum of 1000 resources. To set the feed page size, set the following RQM Integration Component ( com.ibm.rqm.integration.service.internal.IntegrationService ) advanced server configuration property (see Configuring advanced properties in the Collaborative Lifecycle Management Online Help):

Max Feed Entries/Page

Note: The links to other pages in a feed cannot be pasted directly into a browser to get that page. This is because the link contains a query segment that looks something like this: ?token=_C8DasVZWEeG429XX9GztHA%26page=1 where the &'s are escaped (e.g. %26). To use the link the &'s must be unescaped by turning all instances of "%26" to "&". That would make the query segment look something like: ?token=_C8DasVZWEeG429XX9GztHA&page=1

Comments

Samanwita Majumdar commented Apr 30 '13, 8:24 a.m.

I have a similar problem, trying to get RQM test cases and the system has more than 50 however my query returns back only 50. I am using the following query - https://host:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/project area/testcase. how can this query be parameterised so that I get all of the testcases in the system. Can there be the list of steps that need to be followed?

Ara Masrof commented Apr 30 '13, 8:36 a.m. | edited Apr 30 '13, 8:37 a.m.

JAZZ DEVELOPER

If you go to https://<PublicURI>/qm/admin -> Advanced properties

You can modify the Max Feed Entry (as noted in the RQM API reference)

Paul Slauenwhite commented May 01 '13, 6:09 a.m. | edited May 01 '13, 6:09 a.m.

FORUM MODERATOR / JAZZ DEVELOPER

See:

https://jazz.net/wiki/bin/view/Main/RqmApi#Feeds

permanent link

Glenn Henderson (6●4●5) | answered Dec 05 '14, 6:54 a.m.

I'm at a loss trying to understand how providing the link https://jazz.net/wiki/bin/view/Main/RqmApi#Feeds solves this answer?

How does one actually make the change? If you are not an admin, only having a RESTful request, what does one need to include in the REST get / post such that they can change the max entries per page? The references provided seem to give no clue / indication to this,

Is "com.ibm.rqm.integration.service.internal.IntegrationService" appended to the URL in some manner?

Is "Max Feed Entries/Page" appended to the URL in some manner?

Is there an example that actually shows this in the Rest URL so I know how it's syntax? I just can't figure out what to do with these two parameters in a RESTful request.

Comments

Paul Slauenwhite commented Dec 05 '14, 9:40 a.m.

FORUM MODERATOR / JAZZ DEVELOPER

Hi Glenn,

If you plan on using the RQM Reportable REST API, you need need to become familiar with the API by reading the documentation in the WIKI.

The solution to this problem is covered by these posts.

Glenn Henderson commented Dec 05 '14, 2:02 p.m. | edited Dec 05 '14, 2:03 p.m.

Hi Paul,

I am well familiar with using REST and why I raised the question. With RTC, Jira, TargetProcess, apTest, etc., we can easily change the page size of the returns. Most other well thought out tools have a simple &size= and &startat or &pos= entry in the URL to specify the maximum number of results and the starting point.

However, for RQM, the exact parameter page size entry is escaping me. I don't see it in the RQM REST API, only the reference to com.ibm.rqm.integration.service.internal.IntegrationService and that can be changed. But not what the actual syntax is.

I know how to easily navigate the RQM feeds for pages, but just haven't figured out how to change the page size. Can you point to a specific syntax or example in the API guide? I don't see one there.

This same question has been asked before with most answers being that cannot be changed. The documentation says that it can be changed, but doesn't say how to via a RESTful request.

Paul Slauenwhite commented Dec 06 '14, 12:19 p.m.

FORUM MODERATOR / JAZZ DEVELOPER

Hi Glenn,

The RQM Reportable REST API does not support a feed page size parameter. As mentioned, the feed page size is controlled by the Max Feed Entries/Page Advanced Property.

permanent link

Anitha Pathuri (8●9●18) | answered Dec 22 '17, 4:14 a.m.

Hi Ara,

If the project contains more than 1000 artifacts (test scripts) then how to export next set after exporting first 1000 artifacts? i have refererred your explanation above "By default, the feed page size is set to 50 resources, but it can be modified to a maximum of 1000 resources."

Thanks,

Anitha

0	permanent link V D (13●3) \| answered Nov 23 '20, 1:22 a.m. We are stuck here. We have more than 1500 testcases in our project area. How can we use the RQM API to fetch Testcases more than 512 (the upper limit for feed fetch is 512)?

permanent link

Stefan Schmelz (57●1●18●21) | answered Nov 23 '20, 3:44 a.m.

The API describes the number of entries in a single page, which can be enlarged to 512.

The other entries then are prepared in other pages, which are referenced in the feed:

"<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
<title type="text">testcase ATOM feed for project area Test (QM)</title>
<id>https://clm4.local/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/Test+%28QM%29/testcase</id>
<link href="https://clm4.local/qm/web/console/" rel="alternate"/>
<link rel="self" href="https://clm4.local/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/Test+%28QM%29/testcase?oslc_config.context=https%3A%2F%2Fclm4.local%2Fgc%2Fconfiguration%2F6&token=_GOmpoC1nEeuQd9wKCQ4OUA&page=0"/>
<link rel="next" href="https://clm4.local/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/Test+%28QM%29/testcase?oslc_config.context=https%3A%2F%2Fclm4.local%2Fgc%2Fconfiguration%2F6&token=_GOmpoC1nEeuQd9wKCQ4OUA&page=1"/>
<link rel="last" href="https://clm4.local/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/Test+%28QM%29/testcase?oslc_config.context=https%3A%2F%2Fclm4.local%2Fgc%2Fconfiguration%2F6&token=_GOmpoC1nEeuQd9wKCQ4OUA&page=39"/>
<entry xmlns="http://www.w3.org/2005/Atom">
[...]"

therefore you can handle the information programmatically and can balance the time to fetch results.

BTW if you report using RPE, you do not need to care about those pages, because RPE does this for you.

0	permanent link V D (13●3) \| answered Nov 25 '20, 1:41 a.m. Thanks Stefan, I was able to get all pages polling the rel=next attribute of the link tag.

Your answer

Register or log in to post your answer.

Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.

It's all about the answers!

Related questions

RQM REST - How to get more than 50 items in response?

6 answers

Your answer