HP OneView REST API Reference

datacenters
datacenters.html[10/17/2013 10:35:40 AM]
query Experimental This parameter is experimental for this release: 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.
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
DatacenterList The array of filtered resources from start up to a
maximum of count.
Response Codes
REST API Response Codes
Examples
Gets all data centers:
https://{appl}/rest/datacenters
Gets only five data centers:
https://{appl}/rest/datacenters?count=5
Gets all data centers order by data center name ascending:
https://{appl}/rest/datacenters?sort=name:asc
Gets the data center resource with name test:
https://{appl}/rest/datacenters?filter="name='test'"
Gets all data centers with a uuid that starts with b0fb8894:
https://{appl}/rest/datacenters?filter="uuid matches
'b0fb8894%25'"
(%25 is the encoded value for the wild character (%), and is
required to do partial matches.)