Maintain control of your Microsoft 365 data
Post Reply
b.st
Novice
Posts: 6
Liked: 2 times
Joined: Apr 30, 2020 6:13 pm
Contact:

VBO RESTful API sorting

Post by b.st »

Hi,

Is there any way to sort the items returned in the VBO's RESTful API response? I couldn't find any info on sorting in your online docs... I'm interested in sorting the items from https://helpcenter.veeam.com/docs/vbo36 ... tml?ver=40 specifically (or even better if there's something that can be used with VBO APIs in general).

Thanks,
Boris
b.vanhaastrecht
Service Provider
Posts: 929
Liked: 180 times
Joined: Aug 26, 2013 7:46 am
Full Name: Bastiaan van Haastrecht
Location: The Netherlands
Contact:

Re: VBO RESTful API sorting

Post by b.vanhaastrecht »

Would like to know this to. Subscribe.
======================================================
Veeam ProPartner and Service Provider
b.st
Novice
Posts: 6
Liked: 2 times
Joined: Apr 30, 2020 6:13 pm
Contact:

Re: VBO RESTful API sorting

Post by b.st »

To clarify what I'm asking... We're looking for a way to make VBO sort the items before sending them in a response. Sorting the items on client side is not really an option since the RESTful API is using paging thus returning only partial set of data we're querying.

We haven't opened a ticket with Veeam support yet as we're just trying to find out if the sorting is already possible.
Polina
Veeam Software
Posts: 3927
Liked: 993 times
Joined: Oct 21, 2011 11:22 am
Full Name: Polina Vasileva
Contact:

Re: VBO RESTful API sorting

Post by Polina »

Hi Boris,

Sorting is currently not supported, and we can take it as a feature request for the next releases. Any details on why do you need it/parameters to sort on?
b.st
Novice
Posts: 6
Liked: 2 times
Joined: Apr 30, 2020 6:13 pm
Contact:

Re: VBO RESTful API sorting

Post by b.st » 2 people like this post

Hi,

A number of our customers have requested the items (sites, documents, etc.) to be sorted by name when viewing restore sessions. The items should be sorted server side (before they are paged) to maintain the proper sort order. Sorting the items client side would require fetching all items first which kind of defeats the purpose of the whole paging functionality.

Regards,
Boris
jcoulson
Lurker
Posts: 1
Liked: 2 times
Joined: Nov 08, 2022 3:44 pm
Full Name: Jordan Coulson
Contact:

[MERGED] [Feature Request] Restful API ordering

Post by jcoulson » 2 people like this post

Hi,

As per topic here: veeam-backup-for-microsoft-365-f47/vbo- ... 69435.html
The last post is exactly what I am after:
A number of our customers have requested the items (mailboxes, sites, documents, etc.) to be sorted by name when viewing restore sessions.
The items should be sorted server side (before they are paged) to maintain the proper sort order.
Sorting the items client side would require fetching all items first which kind of defeats the purpose of the whole paging functionality.
Extra functionality:
If this was to be made configurable the request could include 2 parameters: sort item (data item name in response), and sort type/direction (alphabetical ascending for example).
Passing these parameters would do the sorting server side before pagination, so when downloaded in pages to the client, the sort order is preserved.

Many thanks,

Jordan
Mildur
Product Manager
Posts: 11598
Liked: 3261 times
Joined: May 13, 2017 4:51 pm
Full Name: Fabian K.
Location: Switzerland
Contact:

Re: VBO RESTful API sorting

Post by Mildur »

Hi Jordan

I moved it to the original topic. No need for a new topic if it's about the same feature.
Thanks for your request. We count it as +1.

Thanks
Fabian
Product Management Analyst @ Veeam Software
t7MevELx0
Service Provider
Posts: 109
Liked: 19 times
Joined: Feb 06, 2024 6:55 pm
Contact:

Re: VBO RESTful API sorting

Post by t7MevELx0 »

Adding another +1 to this request.

We are an MSP building a self-service restore portal on top of the VB365 v8 REST API, and the lack of server-side sorting is a real limitation, especially on the Mailbox Items Restore endpoints.

Right now, Get Mailbox Items supports offset, limit, and parentId, but there is no way to request sorting by received date, subject, sender, or similar fields. For large mailboxes, that means items come back in whatever order the server returns them.

Client-side sorting is not a realistic workaround because the API is paginated. To show results in a sensible order, we would have to pull every page first, sort locally, and then display the results. That defeats the purpose of pagination and does not scale for large mailboxes. The only other option is to show unsorted results, which feels broken to end users.

What would help is optional server-side sorting on collection endpoints, for example:
  • orderColumn
  • orderAsc
That sorting would need to happen before pagination so results stay consistent across pages.

The endpoints where this would help us most are:
  • Get Mailbox Items
  • Get Mailboxes
  • Get Sites / Get Documents
Really, any collection endpoint that supports offset and limit should also support sorting.

This would make a big difference for anyone trying to build a proper user-facing portal on top of the API.



Thanks!
Post Reply

Who is online

Users browsing this forum: No registered users and 11 guests