HP OneView REST API Reference

index/search-suggestions
index-search-suggestions.html[10/17/2013 10:35:58 AM]
query has over filter is that it can have embedded ORs. A
single query parameter can do what would take multiple
parameters or multiple GET requests using filter. Use query for
more complex queries.
view Optional Return a specific subset of the attributes of the resource or
collection by specifying the name of a predefined view. The default
view is expand (show all attributes of the resource, and all
elements of collections or resources).
filter Experimental This parameter is experimental for this release: While generally
functional when used in simple cases, restrictions might be noted in
the implementation description.
A general filter/query string that narrows the list of resources
returned by a multi-resource GET (read) request and DELETE
(delete) request. The default is no filter (all resources are returned).
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the
current release, this must be set to "X-API-Version:3"
Response Description
Suggestions The suggestions for the given search
Response Codes
REST API Response Codes
Examples
Get suggestions for the specified search:
GET https://{appl}/rest/index/search-suggestions?userQuery=ad
URI: /rest/index/search-suggestions/schema
Method API
GET Generates suggestions in JSON format
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the
current release, this must be set to "X-API-Version:3"
Response Description
JsonSchema Returns suggestions in JSON format
Response Codes
REST API Response Codes
Examples