User Manual

4-6
Chapter 4: Redfish Technology Pack
4.2.2 Redfish API defnition
A. OData Support
https://{{ip}}/redfish/v1/Managers/Self/HostInterfaces/
{{hostinterface_instance}}
Redfish API supports Odata v4.0 as it is defined in Redfish specification. All resources within
this REST API are identified by a unique identifier property named @odata.id. Resource
Identifiers shall be represented in JSON payloads as URI paths relative to the Redfish
Schema portion of the URI. That is, they shall always start with
/redfish/
. The resource
identifier is the canonical URL for the resource and can be used to retrieve or edit the
resource, as appropriate. OData Properties that are part of the JSON response for every
Redfish Resource is defined under
4.3.1 ODATA properties
.
B. Protocol version
The protocol version is separate from the version of the resources or the version of the
Redfish Schema supported by them.
The root URI for this version of the Redfish protocol shall be
/redfish/v1/
.
While the major version of the protocol is represented in the URI, the major version, minor
version and errata version of the protocol are represented in the Version property of the
Service Root resource, as defined in the Redfish Schema for that resource. The protocol
version is a string of the form:
Major Version, Minor Version, Errata
Major Version:
integer: something in the class changed in a backward incompatible way.
Minor Version:
integer: a minor update. New functionality may have been added but
nothing removed. Compatibility will be preserved with previous
minor versions.
Errata:
integer: something in the prior version was broken and needed to be fixed.
Any resource discovered through links found by accessing the root service or any service or
resource referenced using references from the root service shall conform to the same version
of the protocol supported by the root service.
C. URI Rules
Redfish Service supports a small set of defined default URIs without authentication. They are:
Table 2 URIs without authentication
URI Description
/redfish
URI used to return the version
/redfish/v1/
URI for the Redfish Service Root
/redfish/v1/odata
URI for OData Service Document
/redfish/v1/$metadata
URI for metadata document
E16160_ASMB9-iKVM_UM_V3.indb 6E16160_ASMB9-iKVM_UM_V3.indb 6 1/17/2020 2:29:24 PM1/17/2020 2:29:24 PM