Page the list result

In this tutorial, you can learn how to tailor responses according to your paging requirements.

Paging in the response

Each GET list API response includes the following paging information:

• current_page: Current page number
• page_entries: Number of entries in the page
• total_entries: Total number of entries
• page_size: Size of each page
• page_links: Structure containing links to first, previous, next, and last pages

For example,

"paging_info": {
    "current_page": 0,
    "page_entries": 5,
    "total_entries": 7,
    "page_size": 5,
    "page_links": [
    {
       "rel": "first",
       "href": "/rest/v1.0/dd-systems/bb5bed4adc90eebb%3A4496a0e4def16e94/mtrees?page=0&size=5"				
    },
    {
       "rel": "last",
       "href": "/rest/v1.0/dd-systems/bb5bed4adc90eebb%3A4496a0e4def16e94/mtrees?page=1&size=5"
    },
    {
       "rel": "next",
       "href": "/rest/v1.0/dd-systems/bb5bed4adc90eebb%3A4496a0e4def16e94/mtrees?page=1&size=5"
    }
   ]
}

Random access paging

In PowerProtect DDMC system, most of the APIs that potentially return a list of resources support random access pagination.

You can implement random access pagination by using the query parameters “page” and “size”:

• page - the current page number
• size - the size of each page

?page=<page-number>&size=<page-size>

For example, if you want to get users on the first page with a page size of 20:

curl --request GET \
     --header 'content-type: application/json' \
     --header 'X-DD-AUTH-TOKEN: <your-auth-token>' \
     --url 'https://<DDMC-SYSTEM-IP/FQDN>:3009/rest/v1.0/dd-systems/bb5bed4adc90eebb%3A4496a0e4def16e94/users?page=0&size=20'

If you specify no paging parameters, the default values apply:

• page - 0
• size - 20

The maximum page size is 200, and the page number starts at 0.