Skip to main content

GET – Service root properties

Use the GET method to retrieve properties in Service Root (/redfish/v1/) for Redfish service.

Request URL

GET https://<BMC_IPADDR>/redfish/v1/

Request body

None

Response body

The response is a JSON object that contains the following parameters:

FieldTypeDescription

Id

String

“RootService”.

Name

String

“Root Service”.

Description

String

This resource is used to represent a service root for a Redfish implementation.

Vendor

String

“Lenovo”

SessionService

Link

A reference link to session service resource.

Managers

Link

A reference link to a collection of managers.

RedfishVersion

String

Version of the implemented Redfish service.

UUID

String

Unique identifier for the service instance.

Chassis

Link

A reference link to chassis resource.

Tasks

Link

A reference link to a collection of tasks.

EventService

Link

A reference link to event service resource.

JsonSchemeas

Link

A reference link to Json Schema resource.

JobService

Link

A reference link to job service resource.

AccountService

Link

A reference link to account service resource.

CertificateService

Link

A reference link to certificate service resource.

Systems

Link

A reference link to a collection of systems.

Registries

Link

A reference link to a collection of registries.

UpdateService

Link

A reference link to update service resource.

TelemetryService

Link

A reference link to telemetry service resource.

LicenseService

Link

A reference link to license service resource.

Links

Object

Expanded.

 

Sessions

Link

A reference link to a collection of sessions.

ProtocolFeaturesSupported

Object

Expanded.

 

ExcerptQuery

Boolean

Indicates whether the 'excerpt' query parameter is supported.

 

FilterQuery

Boolean

Indicates whether the $filter query parameter is supported.

 

OnlyMemberQuery

Boolean

Indicates whether the 'only' query parameter is supported.

 

SelectQuery

Boolean

Indicates whether the $select query parameter is supported.

 

ExpandQuery

Object

Expanded.

  

ExpandAll

Boolean

Indicates whether the $expand support of asterisk (expand all entries) is supported.

  

Levels

Boolean

Indicates whether the expand support of the $levels qualifier is supported by the service.

  

Links

Boolean

Indicates whether the $expand support of tilde (expand only entries in the Links section) is supported.

  

MaxLevels

Integer

Indicates the maximum number value of the $levels qualifier in $expand operations.

  

NoLinks

Boolean

Indicates whether the $expand support of period (only expand entries not in the Links section) is supported.

 

DeepOperations

Object

Expanded

  

DeepPATCH

Boolean

An indication of whether the service supports the deep PATCH operation.

  

DeepPOST

Boolean

An indication of whether the service supports the deep POST operation.

  

MaxLevels

Number

The maximum levels of resources allowed in deep operations.

Status code

HTTP Status CodeError Message ID
500InternalError

Example

The following example JSON response is returned:

{
"Name": "Root Service",
"@odata.type": "#ServiceRoot.v1_13_0.ServiceRoot",
"UpdateService": {
"@odata.id": "/redfish/v1/UpdateService"
},
"AccountService": {
"@odata.id": "/redfish/v1/AccountService"
},
"Chassis": {
"@odata.id": "/redfish/v1/Chassis"
},
"Links": {
"Sessions": {
"@odata.id": "/redfish/v1/SessionService/Sessions"
}
},
"LicenseService": {
"@odata.id": "/redfish/v1/LicenseService"
},
"Managers": {
"@odata.id": "/redfish/v1/Managers"
},
"JobService": {
"@odata.id": "/redfish/v1/JobService"
},
"EventService": {
"@odata.id": "/redfish/v1/EventService"
},
"TelemetryService": {
"@odata.id": "/redfish/v1/TelemetryService"
},
"CertificateService": {
"@odata.id": "/redfish/v1/CertificateService"
},
"ProtocolFeaturesSupported": {
"FilterQuery": true,
"SelectQuery": true,
"DeepOperations": {
"MaxLevels": 2,
"DeepPATCH": true,
"DeepPOST": true
},
"ExpandQuery": {
"MaxLevels": 2,
"Levels": true,
"Links": true,
"NoLinks": true,
"ExpandAll": true
},
"OnlyMemberQuery": true,
"ExcerptQuery": true
},
"@odata.id": "/redfish/v1/",
"SessionService": {
"@odata.id": "/redfish/v1/SessionService"
},
"Vendor": "Lenovo",
"JsonSchemas": {
"@odata.id": "/redfish/v1/JsonSchemas"
},
"@odata.etag": "\"a8cdfeed38022f0af7a4e\"",
"@odata.context": "/redfish/v1/$metadata#ServiceRoot.ServiceRoot",
"Description": "This resource is used to represent a service root for a Redfish implementation.",
"Systems": {
"@odata.id": "/redfish/v1/Systems"
},
"Tasks": {
"@odata.id": "/redfish/v1/TaskService"
},
"UUID": "28993529-94AA-413D-8700-795C38B78C69",
"Registries": {
"@odata.id": "/redfish/v1/Registries"
},
"RedfishVersion": "1.15.0",
"Id": "RootService"
}