HP OneView REST API Reference

uplink-sets
uplink-sets.html[10/17/2013 10:35:32 AM]
with the oldest entry first.
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
UplinkSetCollection An array of uplink set resources
Response Codes
REST API Response Codes
Examples
Get the first 10 uplink set resources in the domain:
GET https://{appl}/rest/uplink-sets?start=0&count=10
Get all the uplink set resources in the domain:
GET https://{appl}/rest/uplink-sets
Get all the uplink set resources used in a given logical interconnect:
GET https://{appl}/rest/uplink-sets?filter=logicalInterconnectUri=/rest/logical-
interconnects/d6adb177-23c7-4bdd-82a2-c6b228273afd
URI: /rest/uplink-sets/schema
Method API
GET Gets the JSON schema for the uplink set.
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 for this resource
Response Codes
REST API Response Codes
Examples
Get the JSON schema for the resource:
GET https://{appl}/rest/uplink-sets/schema
URI: /rest/uplink-sets/{id}
Method API
PUT Updates an uplink set.
Parameter Attributes Description
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"