Pagination
Veeam Backup for Microsoft Office 365 RESTful API uses pagination to return in a response a defined number of resources per page. By default, the server returns the first 30 items of a resource collection on a page. To change this behavior, you can define the following page attributes:
- Offset - excludes from a response page the first N items of a resource collection. Default value: 0.
- Limit - limits the maximum number of items that the server will return on a page. Default value: 30.
|
Veeam Backup for Microsoft Office 365 RESTful API returns resources in the default order based on its own semantics. |
For example, to return a page with 10 mailboxes starting from the 20th, send the following request:
GET https://<Backup-Office365>:<Port>/v3/RestoreSessions/{ID}/Organization/Mailboxes?offset=19&limit=10 |
If it is possible to navigate to other pages, the server will also return the links to the first, previous, and next pages. For example:
"_links": { "first": { "href": "https://support.east.local:4443/v3/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders?offset=0&limit=10" }, "prev": { "href": "https://support.east.local:4443/v3/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders?offset=9&limit=10" }, "self": { "href": "https://support.east.local:4443/v3/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders?offset=19&limit=10" }, "next": { "href": "https://support.east.local:4443/v3/RestoreSessions/bb8572a4-56e5-4f7d-92e3-a0488c304ea6/Organization/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c/Folders?offset=29&limit=10" } } |
Veeam Backup for Microsoft Office 365 RESTful API uses pagination for the following resources:
- Organization backup processing options:
- /Organizations/{ID}/Users
- /Organizations/{ID}/Groups
- /Organizations/{ID}/Sites
- /Organizations/{ID}/Users/{ID}/OneDrives
- Restore Session events:
- Backed up OneDrive components:
- /RestoreSessions/{ID}/Organization/OneDrives
- /RestoreSessions/{ID}/Organization/OneDrives/{ID}/Documents
- /RestoreSessions/{ID}/Organization/OneDrives/{ID}/Folders
- Backed up SharePoint components:
- /RestoreSessions/{ID}/Organization/Sites/{ID}/Libraries
- /RestoreSessions/{ID}/Organization/Sites/{ID}/Documents
- /RestoreSessions/{ID}/Organization/Sites/{ID}/Lists
- /RestoreSessions/{ID}/Organization/Sites/{ID}/Folders
- /RestoreSessions/{ID}/Organization/Sites/{ID}/Items
- /RestoreSessions/{ID}/Organization/Sites/{ID}/Items/{ID}Attachments
- Backed up mailboxes:
- Backed up mailbox folders:
- Backed up mailbox items: