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/30 10:14]
bil
documentation:redfish_api:service_root [2017/10/13 14:51]
vor removed
Line 3: Line 3:
 This object represents the root Redfish service. This object represents the root Redfish service.
  
-Redfish Schema ​Version: [[http://​redfish.dmtf.org/​schemas/​ServiceRoot.v1_1_1.json|v1.1.1]]+Redfish Schema: [[http://​redfish.dmtf.org/​schemas/​ServiceRoot.v1_1_1.json|ServiceRoot ​v1.1.1]]
  
 ===== GET ===== ===== GET =====
Line 25: Line 25:
 | Description | String | No | Provides a description of this resource. | | Description | String | No | Provides a description of this resource. |
 | RedfishVersion | String | No | The version of the Redfish service in format Major.Minor.Errata | | 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. | +| UUID | String | No | 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 [[documentation:​redfish_api:​account_service|Account Service]] | +| AccountService | Object | No | Link to the [[documentation:​redfish_api:​account_service|Account Service]] | 
-| SessionService | Object |  | Link to the [[documentation:​redfish_api:​session_service|Session Service]] | +| SessionService | Object | No | Link to the [[documentation:​redfish_api:​session_service|Session Service]] | 
-| Managers | Object |  | Link to a collection of [[documentation:​redfish_api:​manager_collection|Managers]] | +| Managers | Object | No | Link to a collection of [[documentation:​redfish_api:​manager_collection|Managers]] | 
-| Chassis | Object |  | Link to a collection of [[documentation:​redfish_api:​chassis_collection|Chassis]] | +| Chassis | Object | No | Link to a collection of [[documentation:​redfish_api:​chassis_collection|Chassis]] | 
-| Systems | Object |  | Link to a collection of [[documentation:​redfish_api:​system_collection|Systems]] | +| Systems | Object | No | Link to a collection of [[documentation:​redfish_api:​system_collection|Systems]] | 
-| EthernetSwitches | Object |  | Link to a collection of [[documentation:​redfish_api:​ethernet_switch_collection|Ethernet Switches]] | +| EthernetSwitches | Object | No | Link to a collection of [[documentation:​redfish_api:​ethernet_switch_collection|Ethernet Switches]] | 
-| PcieSwitches | Object |  | Link to a collection of [[documentation:​redfish_api:​pcie_switch_collection|Pcie Switches]] | +| PcieSwitches | Object | No | Link to a collection of [[documentation:​redfish_api:​pcie_switch_collection|Pcie Switches]] | 
-| ComposedNodes | Object |  | Link to a collection of [[documentation:​redfish_api:​composed_node_collection|Composed Nodes]] | +| ComposedNodes | Object | No | Link to a collection of [[documentation:​redfish_api:​composed_node_collection|Composed Nodes]] | 
-Oem Array  Collection of [[documentation:​redfish_api:​service_root#OEM|OEM]] extensions  ​+Links Object ​No | [[#Links|Links]] to other resources that are related to this resource ​
-Links Object ​ | [[documentation:​redfish_api:​service_root#Links|Links]] to other resources that are related to this resource |+Oem Array No Collection of [[#OEM extensions|OEM extensions]] providing additional properties for this resource |
  
- +=== Links ===
-=== OEM ===+
  
 ^ Attribute ^ Type ^ Nullable ^ Description ^ ^ Attribute ^ Type ^ Nullable ^ Description ^
-RECS.Box ​| Object |  OEM extension ​[[documentation:​redfish_api:​service_root#​RECS.Box|RECS.Box]] |+Sessions ​| Object | No Link to a collection of active ​[[documentation:​redfish_api:​session_collection|Sessions]] |
  
-== RECS.Box ​==+=== OEM extensions ===
  
 ^ Attribute ^ Type ^ Nullable ^ Description ^ ^ Attribute ^ Type ^ Nullable ^ Description ^
-ApiVersion ​String ​| No | Version of the RECS%%|%%Box Redfish API in Format Major.Minor.Errata ​|+RECS.Box ​Object ​| No | [[#RECS.Box extension|RECS.Box extension]] ​|
  
-=== Links ===+== RECS.Box extension ​==
  
 ^ Attribute ^ Type ^ Nullable ^ Description ^ ^ Attribute ^ Type ^ Nullable ^ Description ^
-Sessions ​Object ​ Link to a collection ​of active [[documentation:​redfish_api:​session_collection|Sessions]] ​| +ApiVersion ​String ​No Version ​of the RECS%%|%%Box Redfish API in Format Major.Minor.Errata ​|
  
 === Example response data === === Example response data ===
Line 89: Line 87:
  "​ComposedNodes":​ {   "​ComposedNodes":​ { 
  "​@odata.id":​ "​[[documentation:​redfish_api:​composed_node_collection|/​redfish/​v1/​ComposedNodes]]" ​  "​@odata.id":​ "​[[documentation:​redfish_api:​composed_node_collection|/​redfish/​v1/​ComposedNodes]]" ​
 + }, 
 + "​Links":​ {
 + "​Sessions"​ : {
 + "​@odata.id":​ "​[[documentation:​redfish_api:​session_collection|/​redfish/​v1/​SessionService/​Sessions]]"​
 + }
  },   }, 
  "​Oem":​ {   "​Oem":​ { 
Line 95: Line 98:
  "​ApiVersion":​ "​0.01.00", ​  "​ApiVersion":​ "​0.01.00", ​
  
- },  
- "​Links":​ { 
- "​Sessions"​ : { 
- "​@odata.id":​ "​[[documentation:​redfish_api:​session_collection|/​redfish/​v1/​SessionService/​Sessions]]"​ 
- } 
  }  }
 } }