Referencing OEM Extensions.

In this example, ServiceRoot has the "Oem" property filled out to point to an OEM defined entity.


First, the $metadata resource; note that towards the bottom there are references to schemas found outside of the DMTF schema folder (in particular ContosoExtensions_v1.xml and TurboencabulatorService_v1.xml).

<?xml version="1.0" encoding="UTF-8"?>
<!-- Copyright 2014-2016 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright.-->
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">

<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/ServiceRoot_v1.xml">
<edmx:Include Namespace="ServiceRoot"/>
<edmx:Include Namespace="ServiceRoot.v1_1_1"/>
</edmx:Reference>

<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/AccountService_v1.xml">
<edmx:Include Namespace="AccountService"/>
<edmx:Include Namespace="AccountService.v1_0_2"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/ManagerAccount_v1.xml">
<edmx:Include Namespace="ManagerAccount"/>
<edmx:Include Namespace="ManagerAccount.v1_0_2"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/ManagerAccountCollection_v1.xml">
<edmx:Include Namespace="ManagerAccountCollection"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Message_v1.xml">
<edmx:Include Namespace="Message"/>
<edmx:Include Namespace="Message.v1_0_0"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Role_v1.xml">
<edmx:Include Namespace="Role"/>
<edmx:Include Namespace="Role.v1_0_2"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RoleCollection_v1.xml">
<edmx:Include Namespace="RoleCollection"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Session_v1.xml">
<edmx:Include Namespace="Session"/>
<edmx:Include Namespace="Session.v1_0_2"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/SessionCollection_v1.xml">
<edmx:Include Namespace="SessionCollection"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/SessionService_v1.xml">
<edmx:Include Namespace="SessionService"/>
<edmx:Include Namespace="SessionService.v1_0_2"/>
</edmx:Reference>

<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
<edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="RedfishExtensions"/>
</edmx:Reference>

<edmx:Reference Uri="http://Contoso.com/schemas/ContosoExtensions_v1.xml">
<edmx:Include Namespace="ContosoExtensions.v1_0_0"/>
</edmx:Reference>
<edmx:Reference Uri="http://Contoso.com/schemas/TurboencabulatorService_v1.xml">
<edmx:Include Namespace="TurboencabulatorService"/>
<edmx:Include Namespace="TurboencabulatorService.v1_0_0"/>
</edmx:Reference>

<edmx:DataServices>

<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Service">
<EntityContainer Name="Service" Extends="ContosoExtensions.v1_0_0.ServiceContainer"/>
</Schema>

</edmx:DataServices>
</edmx:Edmx>


And this is how the ServiceRoot resource response is extended to provide a new navigation property; note how the "Oem" property contains the odata.type in the ContosoExtensions namespace.

{
"@odata.type": "#ServiceRoot.v1_1_1.ServiceRoot",
"Id": "RootService",
"Name": "Root Service",
"RedfishVersion": "1.0.2",
"UUID": "92384634-2938-2342-8820-489239905423",
"SessionService": {
"@odata.id": "/redfish/v1/SessionService"
},
"AccountService": {
"@odata.id": "/redfish/v1/AccountService"
},
"Links": {
"Sessions": {
"@odata.id": "/redfish/v1/SessionService/Sessions"
}
},
"Oem": {
"Contoso": {
"@odata.type": "#ContosoExtensions.v1_0_0.ServiceRoot",
"TurboencabulatorService": {
"@odata.id": "/redfish/v1/TurboencabulatorService"
}
}
},
"@odata.context": "/redfish/v1/$metadata#ServiceRoot.ServiceRoot",
"@odata.id": "/redfish/v1/",
"@Redfish.Copyright": "Copyright 2014-2016 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright."
}


And for reference is the sample ContosoExtensions_v1.xml file; notice the ComplexType with the name "ServiceRoot"

<?xml version="1.0" encoding="UTF-8"?>
<!---->
<!--################################################################################ -->
<!--# Contoso Schema: ContosoExtensions v1.0.0-->
<!--# -->
<!--# Copyright 2014-2016 Distributed Management Task Force, Inc. (DMTF). -->
<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
<!--################################################################################ -->
<!---->
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">

<edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
<edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/ServiceRoot_v1.xml">
<edmx:Include Namespace="ServiceRoot.v1_1_1"/>
</edmx:Reference>
<edmx:Reference Uri="http://Contoso.com/schemas/TurboencabulatorService_v1.xml">
<edmx:Include Namespace="TurboencabulatorService"/>
</edmx:Reference>

<edmx:DataServices>

<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ContosoExtensions.v1_0_0">

<EntityContainer Name="ServiceContainer" Extends="ServiceRoot.v1_1_1.ServiceContainer">
<Singleton Name="TurboencabulatorService" Type="TurboencabulatorService.TurboencabulatorService"/>
</EntityContainer>

<ComplexType Name="ServiceRoot">
<NavigationProperty Name="TurboencabulatorService" Type="TurboencabulatorService.TurboencabulatorService" Nullable="false">
<Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
<Annotation Term="OData.Description" String="Link to the Turboencabulator Service."/>
<Annotation Term="OData.LongDescription" String="This property shall contain the link to the Turboencabulator Service."/>
<Annotation Term="OData.AutoExpandReferences"/>
</NavigationProperty>
</ComplexType>

</Schema>

</edmx:DataServices>
</edmx:Edmx>

Actions in the response payload are represented in the following manner:

{
"#Namespace.ActionName": {
"target": "some URI"
}
}

This format is defined by OData and leveraged by Redfish. "Namespace" is the CSDL Namespace where the action is defined, and "ActionName" is the name of the Action object in the schema file. The "Namespace" can ultimately be found based on the referenced namespaces in the $metadata resource.

So, if a client were to come across the action "#Contoso.Reset", the methodology to resolve where the action is defined would be to:

1. Go to the $metadata resource and locate the namespace "Contoso"
   
2. Go to the file referenced by $metadata and locate the namespace "Contoso"
   
3. Within the "Contoso" namespace, locate the Action named "Reset"
   

This same process can be applied generically with all actions (not just OEM actions).

Unfortunately the DPS2043 bundle does not have the $metadata resource updated to include these same OEM namespaces. But effectively to correct this, $metadata would also include something like this:

<edmx:Reference Uri="http://Contoso.com/schemas/Contoso_v1.xml">
<edmx:Include Namespace="Contoso"/>
</edmx:Reference>