HP OneView REST API Reference

interconnect-types
interconnect-types.html[10/17/2013 10:35:39 AM]
Updated: October 16, 2013 4:31
MDT
API Specifications Create Read Update Delete
/rest/interconnect-types GET
/rest/interconnect-types/schema GET
/rest/interconnect-types/{id} GET
Resource Model
InterconnectType
InterconnectTypeCollection
HP OneView REST API Reference
interconnect-types
An interconnect type associates the following: an interconnect model, part number, uplink and downlink port structure and
capabilities, and supported firmware versions. Interconnect types are automatically populated. They cannot be directly
created or deleted. Together with an interconnect location, an interconnect type is used to construct an interconnect map.
An interconnect map identifies locations and, for each location, the arrangement of expected (and permitted) interconnect
types. An interconnect map is used when constructing a logical interconnect or a logical interconnect group, and does not
exist independently. The REST API (GET) supports an 'accept-language' in the request field. The default is 'en_US'. An
'auth:{token}' in the request header is required. The {token} can be retrieved from https://{appl}/rest/login-sessions.
URI: /rest/interconnect-types
Method API
GET Gets a paginated collection of all the interconnect types based on the specified parameters. Filters
can be used in the URL to control the number of interconnect types that are returned. With no
filters specified, the API returns all supported interconnect interconnect types.
Parameter Attributes Description
start Optional The 0-based index of the first resource to return (start=0
starts with the first available resource). If the specified count
does not return all resources within the maximum allowed
time (see count), use the start parameter to view
additional resource pages. The default value for start is 0
(first available resource).
count Optional Optional parameter that specifies the number of resources to
return from each API invocation. The number of resources
returned on each call is referred to as a page. If you specify
a count, the API attempts to return the specified number of
resources, however this may be limited due to response
time constraints and/or actual number of resources available
to return. The results include the total number of resources
that match the filter or query, the actual count
returned, and the URIs to go to the next page, previous
page, or both. If necessary, you can make several requests
using the URI for the next or previous page (or different
start parameters) to get the desired count.
sort Optional The sort order of the returned data set. By default, the sort
order is based on the create time, with the oldest entry first.
filter Experimental This parameter is experimental for this release: While
generally functional when used in simple cases, restrictions