meta data for this page
  •  

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
documentation:redfish_api:service_root [2017/03/30 09:43] bildocumentation:redfish_api:service_root [2017/10/13 12:51] (current) – removed vor
Line 1: Line 1:
-====== Service Root ====== 
  
-This object represents the root Redfish service. 
- 
-Redfish Schema: [[http://redfish.dmtf.org/schemas/ServiceRoot.v1_1_1.json|ServiceRoot v1.1.1]] 
- 
-===== GET ===== 
- 
-==== Request ==== 
- 
-<code> 
-GET /redfish/v1 
-Content-Type: applicaton/json 
-</code> 
- 
-=== Authorisation === 
- 
-No authorisation reqired. 
- 
-==== 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 | 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 | No | Link to the [[documentation:redfish_api:account_service|Account Service]] | 
-| SessionService | Object | No | Link to the [[documentation:redfish_api:session_service|Session Service]] | 
-| Managers | Object | No | Link to a collection of [[documentation:redfish_api:manager_collection|Managers]] | 
-| Chassis | Object | No | Link to a collection of [[documentation:redfish_api:chassis_collection|Chassis]] | 
-| Systems | Object | No | Link to a collection of [[documentation:redfish_api:system_collection|Systems]] | 
-| EthernetSwitches | Object | No | Link to a collection of [[documentation:redfish_api:ethernet_switch_collection|Ethernet Switches]] | 
-| PcieSwitches | Object | No | Link to a collection of [[documentation:redfish_api:pcie_switch_collection|Pcie Switches]] | 
-| ComposedNodes | Object | No | Link to a collection of [[documentation:redfish_api:composed_node_collection|Composed Nodes]] | 
-| Links | Object | No | [[#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 === 
- 
-^ Attribute ^ Type ^ Nullable ^ Description ^ 
-| Sessions | Object | No | Link to a collection of active [[documentation:redfish_api:session_collection|Sessions]] | 
- 
-=== OEM extensions === 
- 
-^ Attribute ^ Type ^ Nullable ^ Description ^ 
-| RECS.Box | Object | No | [[#RECS.Box extension|RECS.Box extension]] | 
- 
-== RECS.Box extension == 
- 
-^ Attribute ^ Type ^ Nullable ^ Description ^ 
-| ApiVersion | String | No | Version of the RECS%%|%%Box Redfish API in Format Major.Minor.Errata | 
- 
-=== Example response data === 
- 
-<codedoc code:whitespace> 
-{ 
- "@odata.context": "/redfish/v1/$metadata#ServiceRoot.ServiceRoot", 
- "@odata.id": "/redfish/v1/",  
- "@odata.type": "[[http://redfish.dmtf.org/schemas/ServiceRoot.v1_1_1.json|#ServiceRoot.v1_1_1.ServiceRoot]]", 
- "Id": "RootService", 
- "Name": "Root Service", 
- "Description": "This object represents the root Redfish service.", 
- "RedfishVersion": "[[http://redfish.dmtf.org/schemas/DSP0266_1.1.html|1.1.0]]",  
- "UUID": "fc9a2b8c-0e75-40d5-900d-7401c4b0d444", 
- "AccountService": 
- "@odata.id": "[[documentation:redfish_api:account_service|/redfish/v1/AccountService]]" 
- }, 
- "SessionService": 
- "@odata.id": "[[documentation:redfish_api:session_service|/redfish/v1/SessionService]]"  
- },  
- "Managers": 
- "@odata.id": "[[documentation:redfish_api:manager_collection|/redfish/v1/Managers]]"  
- },  
- "Chassis": 
- "@odata.id": "[[documentation:redfish_api:chassis_collection|/redfish/v1/Chassis]]"  
- },  
- "Systems": 
- "@odata.id": "[[documentation:redfish_api:system_collection|/redfish/v1/Systems]]"  
- },  
- "EthernetSwitches": 
- "@odata.id": "[[documentation:redfish_api:ethernet_switch_collection|/redfish/v1/EthernetSwitches]]"  
- }, 
- "PcieSwitches": 
- "@odata.id": "[[documentation:redfish_api:pcie_switch_collection|/redfish/v1/PcieSwitches]]"  
- },  
- "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": 
- "RECS.Box": 
- "@odata.type": "#RECS.Box.Oem.ServiceRoot",  
- "ApiVersion": "0.01.00",  
- 
- } 
-} 
-</codedoc> 
- 
-===== 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.