Apply Filters

The services of the vRealize Orchestrator REST API support additional URL parameters that allow you to narrow the objects that HTTP requests to the API return.

Different query parameters are supported for every URL to a resource that you can access through the REST API. For information on valid query parameters, see the vRealize Orchestrator REST API reference documentation.
Note: The reference documentation of the vRealize Orchestrator REST API is installed together with the appliance. You can access the reference documentation at https://{orchestrator_fqdn}/vco/api/docs.

Procedure

  • ♦ To narrow the results from a request at a certain URL, apply filters at the end of the URL:
    URL?filter_1& filter_2&filter_3&....&filter_N. Every filter contains query parameters that are valid for the relevant URL.

Example: Filter Workflows

If you look for workflows that contain a specific word in their name, for example datastore, you can apply the following filter in a request to the Catalog service: 

GET https://{orchestrator_fqdn}/vco/api/catalog/System/Workflow?conditions=name~datastore

To limit the amount of the workflows that are returned to a certain number, for example five, apply an additional filter to the request: 

GET https://{orchestrator_fqdn}/vco/api/catalog/System/Workflow?conditions=name~datastore&maxResult=5