HP OneView REST API Reference

server-profiles
server-profiles.html[10/17/2013 10:35:14 AM]
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).
Not supported
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
ServerProfileListV1 The array of Server Profiles objects which match the request
Response Codes
REST API Response Codes
Examples
Retrieve all server profiles. The number of server
profiles that can be returned with a single call is
limited to a maximum of 256. If the number of profiles
does not exceed the limit, then all profiles are returned;
otherwise, the list is truncated.
GET https://{appl}/rest/server-profiles
Retrieve up to 25 server profiles. If there are fewer than
25 profiles, all profiles will be returned:
GET https://{appl}/rest/server-profiles?count=25
Retrieve the 26th through 50th server profile. If there
are fewer than 25 profiles, no profiles are returned.
GET https://{appl}/rest/server-profiles?start=25&count=25
Retrieve the first 10 profiles matching the name
"*Profile*":
GET https://{appl}/rest/server-profiles?count=10&
filter="name matches '%25Profile%25'"
Retrieve the first 10 profiles matching the name
"*Profile*" in ascending order on column "created":
GET https://{appl}/rest/server-profiles?count=10&
filter="name matches '%25Profile%25'"&sort=created:asc