Query Parameters

To control the amount and order of data that the Orchestrator REST API returns for a resource or collection, you can use the following Orchestrator REST API query parameters:


Query parameters are part of a URL. The question mark (?) separates query parameters from a resource collection endpoint.

Any resource property of a Orchestrator REST API resource schema can be used as a parameter value for the filter and sort Orchestrator REST API query parameters. For example, to return a list of restore plans, use the planType property of the /Plans resource model as a parameter value for the filter query parameter in the following request:

GET https://uwin2012r2.n.local:9898/api/v7.1/Plans?filter=[{"property":"planType","operator":"==","value":"Restore"}]

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