meta data for this page
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revisionLast revisionBoth sides next revision | ||
| documentation:redfish_api:service_root [2017/03/24 14:55] – created bil | documentation:redfish_api:service_root [2017/03/30 09:43] – bil | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Service Root ====== | ====== Service Root ====== | ||
| + | |||
| + | This object represents the root Redfish service. | ||
| + | |||
| + | Redfish Schema: [[http:// | ||
| ===== GET ===== | ===== GET ===== | ||
| Line 9: | Line 13: | ||
| Content-Type: | Content-Type: | ||
| </ | </ | ||
| + | |||
| + | === Authorisation === | ||
| + | |||
| + | No authorisation reqired. | ||
| ==== Response ==== | ==== 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: | ||
| + | | SessionService | Object | No | Link to the [[documentation: | ||
| + | | Managers | Object | No | Link to a collection of [[documentation: | ||
| + | | Chassis | Object | No | Link to a collection of [[documentation: | ||
| + | | Systems | Object | No | Link to a collection of [[documentation: | ||
| + | | EthernetSwitches | Object | No | Link to a collection of [[documentation: | ||
| + | | PcieSwitches | Object | No | Link to a collection of [[documentation: | ||
| + | | ComposedNodes | Object | No | Link to a collection of [[documentation: | ||
| + | | Links | Object | No | [[# | ||
| + | | 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: | ||
| + | |||
| + | === 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 | ||
| { | { | ||
| - | " | + | " |
| " | " | ||
| - | " | + | " |
| - | " | + | " |
| + | " | ||
| " | " | ||
| - | " | + | " |
| - | " | + | |
| " | " | ||
| " | " | ||
| - | " | + | " |
| }, | }, | ||
| " | " | ||
| - | " | + | " |
| }, | }, | ||
| " | " | ||
| - | " | + | " |
| }, | }, | ||
| " | " | ||
| - | " | + | " |
| }, | }, | ||
| " | " | ||
| - | " | + | " |
| }, | }, | ||
| " | " | ||
| - | " | + | " |
| }, | }, | ||
| " | " | ||
| - | " | + | " |
| }, | }, | ||
| " | " | ||
| - | " | + | " |
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| }, | }, | ||
| " | " | ||
| Line 51: | Line 98: | ||
| " | " | ||
| } | } | ||
| - | }, | ||
| - | " | ||
| - | " | ||
| - | " | ||
| - | } | ||
| } | } | ||
| } | } | ||
| - | </code> | + | </codedoc> |
| ===== PUT ===== | ===== PUT ===== | ||