Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
documentation:redfish_api:service_root [2017/03/24 16:16]
bil [Service Root]
— (current)
Line 1: Line 1:
-====== Service Root ====== 
  
-===== GET ===== 
- 
-==== Request ==== 
- 
-<​code>​ 
-GET /redfish/v1 
-Content-Type:​ applicaton/​json 
-</​code>​ 
- 
-==== Response ==== 
- 
-^ Attribute ^ Type ^ Nullable ^ Description ^ 
-| Id | String | No | Uniquely identifies the resource within the collection of like resources. | 
-| Name | String | No | The name of the resource or array element. | 
-| Description | String | No | Provides a description of this resource. | 
-| RedfishVersion | String | No | The version of the Redfish service in format Major.Minor.Errata | 
-| UUID | String |  | Unique identifier for a service instance. The format of this string is a 32-byte value in the form 8-4-4-4-12. If SSDP is used, this value is an exact match of the UUID value returned in a 200OK from an SSDP M-SEARCH request during discovery. Client software should only treat the overall value as a universally unique identifier and should not interpret any sub-fields within the UUID. | 
-| AccountService | Object |  | Link to the Account Service | 
-| SessionService | Object |  | Link to the Session Service | 
-| Managers | Object |  | Link to a collection of Managers | 
-| Chassis | Object |  | Link to a collection of Chassis | 
-| Systems | Object |  | Link to a collection of Systems | 
-| EthernetSwitches | Object |  | Link to a collection of Ethernet Switches | 
-| PcieSwitches | Object |  | Link to a collection of PCIe Switches | 
-| ComposedNodes | Object |  | Link to a collection of Composed Nodes | 
-| Oem | Object |  | OEM extension “RECS.Box”:​ | 
-| Links | Object |  | Contains references to other resources that are related to this resource. | 
- 
-<code javascript service_root_response_example.json>​ 
-{ 
- "​@odata.context":​ "/​redfish/​v1/​$metadata#​ServiceRoot.ServiceRoot", ​ 
- "​@odata.id":​ "/​redfish/​v1/", ​ 
- "​@odata.type":​ "#​ServiceRoot.v1_1_1.ServiceRoot", ​ 
- "​Id":​ "​RootService", ​ 
- "​Name":​ "Root Service", ​ 
- "​Description":​ "This object represents the root Redfish service.",​ 
- "​RedfishVersion":​ "​1.1.0", ​ 
- "​UUID":​ "​fc9a2b8c-0e75-40d5-900d-7401c4b0d444",​ 
- "​AccountService":​ {  
- "​@odata.id":​ "/​redfish/​v1/​AccountService" ​ 
- }, 
- "​SessionService":​ {  
- "​@odata.id":​ "/​redfish/​v1/​SessionService" ​ 
- },  
- "​Managers":​ {  
- "​@odata.id":​ "/​redfish/​v1/​Managers" ​ 
- },  
- "​Chassis":​ {  
- "​@odata.id":​ "/​redfish/​v1/​Chassis" ​ 
- },  
- "​Systems":​ {  
- "​@odata.id":​ "/​redfish/​v1/​Systems" ​ 
- },  
- "​EthernetSwitches":​ {  
- "​@odata.id":​ "/​redfish/​v1/​EthernetSwitches" ​ 
- }, 
- "​PcieSwitches":​ {  
- "​@odata.id":​ "/​redfish/​v1/​PcieSwitches" ​ 
- },  
- "​ComposedNodes":​ {  
- "​@odata.id":​ "/​redfish/​v1/​ComposedNodes" ​ 
- },  
- "​Oem":​ {  
- "​RECS.Box":​ {  
- "​@odata.type":​ "#​RECS.Box.Oem.ServiceRoot", ​ 
- "​ApiVersion":​ "​0.01.00", ​ 
- 
- },  
- "​Links":​ { 
- "​Sessions"​ : { 
- "​@odata.id":​ "/​redfish/​v1/​SessionService/​Sessions"​ 
- } 
- } 
-} 
-</​code>​ 
- 
-===== PUT ===== 
- 
-This Operation is not supported on this resource. 
- 
-===== PATCH ===== 
- 
-This Operation is not supported on this resource. 
- 
-===== POST ===== 
- 
-This Operation is not supported on this resource. 
- 
-===== DELETE ===== 
- 
-This Operation is not supported on this resource.