HP OneView REST API Reference

ethernet-networks
ethernet-networks.html[10/17/2013 10:35:33 AM]
If default query response time is below expectation, the user can
paginate two or more
times to reduce the response time by setting count to a desired number
of Ethernet
network resources to be returned for each page. The next/previous
getters in the
responded collection DTO is used to get the query statement URI for the
next resources
to retrieve or the previous resources retrieved. Pagination query
terminates when next
query URI is NULL.
Example 1: Default query for a one time retrieval for all available
resource.
GET https://{appl}/rest/ethernet-networks or
GET https://{appl}/rest/ethernet-networks?start=0&count=-1
Example 2: Paginated query 1000 resources with count=400.
Initial query statement: GET https://{appl}/rest/ethernet-networks?
start=0&count=400
Next query statement: GET https://{appl}/rest/ethernet-networks?
start=400&count=400
Next query statement: GET https://{appl}/rest/ethernet-networks?
start=800&count=400
Example 3: Default query using sort and filter parameters.
GET https://15.178.214.109/rest/ethernet-networks?
sort=name:ascending&filter=smartLink=false
URI: /rest/ethernet-networks/schema
Method API
GET Gets the Ethernet network 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 Ethernet network schema
Response Codes
REST API Response Codes
Examples
Get the Ethernet network JSON schema:
GET https://{appl}/rest/ethernet-networks/schema
URI: /rest/ethernet-networks/{id}
Method API