User Manual

ASUS ASMB9-iKVM
4-11
4.3 Redfish Resources
This section explains the
Request URI’s and JSON Responses
for the
allowable HTTP
methods
for each of the
Redfish Resources
as explained below from section
4.3.4 Service
Root
. Section
4.3.1 ODATA properties
explains the OData properties that are common
to all the Redfish Entities. Section
4.3.2 User Configurable Properties
explains the user
configurable properties and its reference document for the list. Section
4.3.3 Resource
,
Resource Entity give a brief list of properties which are inherited by all Entities in the sections
given below from
4.3.4 Service Root
.
The following Note is applicable for all API’S.
(M) – DeNotes the mandatory attributes.
(N) - DeNotes Navigation Property. (The properties in Resource Type is inherited by all
properties)
(C) – DeNotes Configurable Property
Please refer to the section
Configurable Keys
in “
How to Add OEM extensions (v1.1)
”
document which needs to be populated at build time to get this property in the JSON
response.
4.3.1 ODATA properties
OData Properties are used to provide information on the resource like its Id, type, context,etc
accessed by an URI. The following are the properties used in Redfish:
For Example:
{
“@odata.context”: “/redfish/v1/$metadata#ServiceRoot”,
“@odata.etag”: “W/\”1488550735\””,
“@odata.id”: “/redfish/v1/”,
“@odata.type”: “#ServiceRoot.v1_0_2.ServiceRoot”
}
Table 5 OData Attributes
Name Type ReadOnly Description
@odata.context String True The value of this property shall be the context URL that
describes the resource according to OData-Protocol and shall
be of the form defined in the Redfish specification.
@odata.id String True The value of this property shall be the unique identifier for
the resource and it shall be of the form defined in the Redfish
specification.
@odata.type String True The value of this property shall be an absolute URL that
specifies the type of the resource and it shall be of the form
defined in the Redfish specification. The type values for each
Redfish Entity gives the schema it follows and is mentioned in
Redfish API List under Schema column.
(continued on the next page)
E16160_ASMB9-iKVM_UM_V3.indb 11E16160_ASMB9-iKVM_UM_V3.indb 11 1/17/2020 2:29:24 PM1/17/2020 2:29:24 PM