Welcome to the Jazz Community Forum
Pagination for Module Views API in Doors Next Generation
I am calling the Module Views API in Doors Next Generation in my widget. I have two questions:
- I am assuming that the results are paginated if they exceed a certain limit. What is that limit?
- If there are more "pages" to be fetched, I'm assuming that the API call to get the next page will be in the href attribute on the <ds:dataSource> element? For example: <ds:dataSource href='urlForNextPage'>. To get the next page would I just have to call the URL in the href attribute, with no further changes to the URL needed?
One answer
I would test it out explicitly but, since it's part of the Reportable REST API, I would assume that it follows the same logic as the others:
- default page size is 100 but can be controlled to an extent by the size parameter in the query string
- if the query would return too much data for one fetch, the result is paginated. If no size parameter is set then it's set to the default of 100. If you set the size but it's too large, it's clamped at the maximum. Either way, rrm:totalCount="<size>" attribute is set with the total number of records returned in that call
- if there are more records to fetch from any call, the rel="next"attribute is set so you know the data is incomplete
- if there are more records to fetch, the href attribute contains a URL encoded reference to fetch the next page, which includes a token parameter that ensures the integrity of the data set at the time you made the call. The page parameter shows the next page that will be fetched and is automatically incremented
Comments
I tested and doesn't look like it responds to the size parameter. For example, there's a view for a module that has 3900 artifacts. Whether or not I specify a value for the size parameter (I tried setting size parameter to 1000) and pos (position) parameter, all 3900 artifacts are returned in a single API call.