HP OneView REST API Reference

connections
connections.html[10/17/2013 10:35:16 AM]
While generally functional when used in simple
cases, restrictions might be noted in the
implementation description.
If the query is supported, the following is the way it
works. A general query string that narrows the list of
resources returned by a multi-resource GET (read)
request and DELETE (delete) request. The default is
no query (all resources are returned). One advantage
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).
fields Optional
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
ConnectionInformationCollection A paginated collection of connection
resources
Response Codes
REST API Response Codes
Examples
Get the first 10 connection resource:
GET https://{appl}/rest/connections?start=0&count=10
Get the connection resource with interconnectUri equal to xxxx:
GET https://{appl}/rest/connections?filter="interconnectUri=xxxx"
URI: /rest/connections/schema
Method API