Pagination of transaction responses

The Pagination feature improves the performance and usability of InfoSphere® MDM Search and GetAll transactions.

Attention: Not all transactions support the Pagination feature. To determine if a Search or GetAll transaction supports Pagination, refer to the documentation for that transaction.

Pagination enables you to retrieve a set of records from the repository, and then view the result set page-by-page in a series of subsets instead of all at once. If a result set for a getAllContracts transaction includes 492 records, the Pagination feature enables you to view, for example, 25 records at a time. To use this feature, the search query request must include a start index and an end index that define the range of retrieved records.

For each Search and GetAll transaction that supports it, the Pagination feature is optional.

Transaction behavior with the Pagination feature

The request header (DWLControl element) contains the Pagination parameters:
  • pageStartIndex
  • pageEndIndex
  • returnAvailableResultCount
If a query request contains values for pageStartIndex and pageEndIndex, then the response returns a subset of the available records that match the search criteria. The size of each subset is based on the range specified by the pageStartIndex and pageEndIndex values.

Optionally, if the returnAvailableResultCount element is set to "true" in the request, the response returns the total number of records in the repository that match the search results. The default value of returnAvailableResultCount is "false".

Example 1

If the pageStartIndex is 1, the pageEndIndex is 10, and the total result count is 15, then 10 records will be returned in the first subset, and 5 records will be returned in the second subset.

Example 2

If the pageStartIndex is 1, the pageEndIndex is 10, and the total result count is 7, then the pageEndIndex is considered to be equal to the total count, and 7 records will be returned in the set.