This is an archive version of the document. To get the most up-to-date information, see the current version.

Orderby System Query Option ($orderby)

The $orderby System Query Option is used to sort resource collections in a response.

For example, to sort failover plans by their state, send the following request:

GET https://uwin2012r2.n.local:9899/v1/FailoverPlans?$orderby=currentState

By default, sorting is made in ascending order. To return resources in a collection in descending order, use the desc suffix. For example, to show enabled failover plans first in the collection, send the following request:

GET https://uwin2012r2.n.local:9899/v1/FailoverPlans?$orderby=currentState%20desc

For the formal grammar of the $orderby query option, see the [OData-ABNF] syntax rule.

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.