HP OneView REST API Reference

roles
roles.html[10/17/2013 10:36:01 AM]
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
RoleNameListV2 RoleNameDtoCollectionV2 collection containing role
names defined
Response Codes
REST API Response Codes
Examples
GET https://{appl}/rest/roles
Example:
Gets all the roles in the appliance
https://localhost/rest/roles
URI: /rest/roles/{roleName}
Method API
GET Gets details of the role from the appliance
Parameter Attributes Description
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
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the