HP OneView REST API Reference

index/resources
index-resources.html[10/17/2013 10:35:56 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 Specifies which fields/columns should be returned in the response
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
IndexResource Contains the resource parameters: name, category,
status, state, description and so on
Response Codes
REST API Response Codes
Examples
This example gets the IndexResource for given resource URI
GET https://{appl}/rest/index/resources/<uri of the resource>
URI: /rest/index/resources/schema
Method API
GET Generates the index resource JSON formatted schema
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 The JSON schema of index resource
Response Codes
REST API Response Codes
Examples
This example generates the index resource schema in JSON format
GET https://{appl}/rest/index/resources/schema
IndexPaginatedCollection