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​

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

Request body​

None

Response body​

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

FieldTypeDescription
IdString

“RootService”.

NameString

“Root Service”.

DescriptionString

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

VendorString

“Lenovo”

SessionServiceLink

A reference link to session service resource.

ManagersLink

A reference link to a collection of managers.

RedfishVersionString

Version of the implemented Redfish service.

UUIDString

Unique identifier for the service instance.

ChassisLink

A reference link to chassis resource.

TasksLink

A reference link to a collection of tasks.

EventServiceLink

A reference link to event service resource.

JsonSchemeasLink

A reference link to Json Schema resource.

JobServiceLink

A reference link to job service resource.

AccountServiceLink

A reference link to account service resource.

CertificateServiceLink

A reference link to certificate service resource.

SystemsLink

A reference link to a collection of systems.

RegistriesLink

A reference link to a collection of registries.

UpdateServiceLink

A reference link to update service resource.

TelemetryServiceLink

A reference link to telemetry service resource.

LinksObject

Expanded.

 SessionsLink

A reference link to a collection of sessions.

ProtocolFeaturesSupportedObject

Expanded.

 ExcerptQueryBoolean

Indicates whether the 'excerpt' query parameter is supported.

 FilterQueryBoolean

Indicates whether the $filter query parameter is supported.

 OnlyMemberQueryBoolean

Indicates whether the 'only' query parameter is supported.

 SelectQueryBoolean

Indicates whether the $select query parameter is supported.

 ExpandQueryObject

Expanded.

  ExpandAllBoolean

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

  LevelsBoolean

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

  LinksBoolean

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

  MaxLevelsInteger

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

  NoLinksBoolean

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

 DeepOperationsObject

Expanded

  DeepPATCHBoolean

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

  DeepPOSTBoolean

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

  MaxLevelsNumber

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:

{
    "Tasks": {
        "@odata.id": "/redfish/v1/TaskService"
    },
    "Chassis": {
        "@odata.id": "/redfish/v1/Chassis"
    },
    "Id": "RootService",
    "ProtocolFeaturesSupported": {
        "ExpandQuery": {
            "Levels": true,
            "NoLinks": true,
            "Links": true,
            "ExpandAll": true,
            "MaxLevels": 2
        },
        "OnlyMemberQuery": true,
        "DeepOperations": {
            "DeepPOST": false,
            "DeepPATCH": false,
            "MaxLevels": 2
        },
        "FilterQuery": true,
        "ExcerptQuery": true,
        "SelectQuery": true
    },
    "Links": {
        "Sessions": {
            "@odata.id": "/redfish/v1/SessionService/Sessions"
        }
    },
    "RedfishVersion": "1.10.0",
    "EventService": {
        "@odata.id": "/redfish/v1/EventService"
    },
    "JsonSchemas": {
        "@odata.id": "/redfish/v1/JsonSchemas"
    },
    "Systems": {
        "@odata.id": "/redfish/v1/Systems"
    },
    "TelemetryService": {
        "@odata.id": "/redfish/v1/TelemetryService"
    },
    "UpdateService": {
        "@odata.id": "/redfish/v1/UpdateService"
    },
    "Registries": {
        "@odata.id": "/redfish/v1/Registries"
    },
    "CertificateService": {
        "@odata.id": "/redfish/v1/CertificateService"
    },
    "UUID": "3D03A592-79E7-11EA-9029-B1651358D6FA",
    "Vendor": "Lenovo",
    "Name": "Root Service",
    "JobService": {
        "@odata.id": "/redfish/v1/JobService"
    },
    "Description": "This resource is used to represent a service root for a Redfish implementation.",
    "@odata.type": "#ServiceRoot.v1_7_0.ServiceRoot",
    "SessionService": {
        "@odata.id": "/redfish/v1/SessionService"
    },
    "@odata.id": "/redfish/v1/",
    "@odata.etag": "\"9d900d0444cd31da3490c\"",
    "AccountService": {
        "@odata.id": "/redfish/v1/AccountService"
    },
    "Managers": {
        "@odata.id": "/redfish/v1/Managers"
    }
}