Query String Options

VAO REST API supports querying according to OData protocol. System Query Options are query string parameters that you can specify to control the amount and order of data that VAO REST API returns for a resource or collection.

VAO REST API supports the following System Query Options:

• Filter System Query Option ($filter)
• Orderby System Query Option ($orderby)
• Top System Query Option ($top)
• Skip System Query Option ($skip)
• Select System Query Option ($select)
• Format System Query Option ($format)

VAO REST API resource properties can be used as query parameters. For example, to find out which failover plans have configured schedules, use the scheduleEnabled property of the /FailoverPlans resource as a parameter for the $orderby query option in the following request:

To learn more about properties of a specific resource, see section Properties in the Resource Reference.