xref: /openbmc/bmcweb/features/redfish/schema/dmtf/csdl/TelemetryData_v1.xml (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)
1*c6d7a45dSGunnar Mills<?xml version="1.0" encoding="UTF-8"?>
2*c6d7a45dSGunnar Mills<!---->
3*c6d7a45dSGunnar Mills<!--################################################################################       -->
4*c6d7a45dSGunnar Mills<!--# Redfish Schema:  TelemetryData v1.0.0                                                -->
5*c6d7a45dSGunnar Mills<!--#                                                                                      -->
6*c6d7a45dSGunnar Mills<!--# For a detailed change log, see the README file contained in the DSP8010 bundle,      -->
7*c6d7a45dSGunnar Mills<!--# available at http://www.dmtf.org/standards/redfish                                   -->
8*c6d7a45dSGunnar Mills<!--# Copyright 2014-2025 DMTF.                                                            -->
9*c6d7a45dSGunnar Mills<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10*c6d7a45dSGunnar Mills<!--################################################################################       -->
11*c6d7a45dSGunnar Mills<!---->
12*c6d7a45dSGunnar Mills<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13*c6d7a45dSGunnar Mills
14*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15*c6d7a45dSGunnar Mills    <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16*c6d7a45dSGunnar Mills  </edmx:Reference>
17*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18*c6d7a45dSGunnar Mills    <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19*c6d7a45dSGunnar Mills  </edmx:Reference>
20*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
21*c6d7a45dSGunnar Mills    <edmx:Include Namespace="Resource"/>
22*c6d7a45dSGunnar Mills    <edmx:Include Namespace="Resource.v1_0_0"/>
23*c6d7a45dSGunnar Mills  </edmx:Reference>
24*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
25*c6d7a45dSGunnar Mills    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
26*c6d7a45dSGunnar Mills  </edmx:Reference>
27*c6d7a45dSGunnar Mills
28*c6d7a45dSGunnar Mills  <edmx:DataServices>
29*c6d7a45dSGunnar Mills
30*c6d7a45dSGunnar Mills    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryData">
31*c6d7a45dSGunnar Mills      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
32*c6d7a45dSGunnar Mills      <Annotation Term="Redfish.Language" String="en"/>
33*c6d7a45dSGunnar Mills
34*c6d7a45dSGunnar Mills      <EntityType Name="TelemetryData" BaseType="Resource.v1_0_0.Resource" Abstract="true">
35*c6d7a45dSGunnar Mills        <Annotation Term="OData.Description" String="The `TelemetryData` schema represents bulk telemetry data from a device or service."/>
36*c6d7a45dSGunnar Mills        <Annotation Term="OData.LongDescription" String="This resource shall represent bulk telemetry data in a Redfish implementation."/>
37*c6d7a45dSGunnar Mills        <Annotation Term="Capabilities.InsertRestrictions">
38*c6d7a45dSGunnar Mills          <Record>
39*c6d7a45dSGunnar Mills            <PropertyValue Property="Insertable" Bool="false"/>
40*c6d7a45dSGunnar Mills          </Record>
41*c6d7a45dSGunnar Mills        </Annotation>
42*c6d7a45dSGunnar Mills        <Annotation Term="Capabilities.UpdateRestrictions">
43*c6d7a45dSGunnar Mills          <Record>
44*c6d7a45dSGunnar Mills            <PropertyValue Property="Updatable" Bool="false"/>
45*c6d7a45dSGunnar Mills          </Record>
46*c6d7a45dSGunnar Mills        </Annotation>
47*c6d7a45dSGunnar Mills        <Annotation Term="Capabilities.DeleteRestrictions">
48*c6d7a45dSGunnar Mills          <Record>
49*c6d7a45dSGunnar Mills            <PropertyValue Property="Deletable" Bool="true"/>
50*c6d7a45dSGunnar Mills          </Record>
51*c6d7a45dSGunnar Mills        </Annotation>
52*c6d7a45dSGunnar Mills        <Annotation Term="Redfish.Uris">
53*c6d7a45dSGunnar Mills          <Collection>
54*c6d7a45dSGunnar Mills            <String>/redfish/v1/TelemetryService/TelemetryData/{TelemetryDataId}</String>
55*c6d7a45dSGunnar Mills          </Collection>
56*c6d7a45dSGunnar Mills        </Annotation>
57*c6d7a45dSGunnar Mills      </EntityType>
58*c6d7a45dSGunnar Mills
59*c6d7a45dSGunnar Mills      <EnumType Name="TelemetryDataTypes">
60*c6d7a45dSGunnar Mills        <Member Name="OEM">
61*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="OEM telemetry data."/>
62*c6d7a45dSGunnar Mills        </Member>
63*c6d7a45dSGunnar Mills      </EnumType>
64*c6d7a45dSGunnar Mills    </Schema>
65*c6d7a45dSGunnar Mills
66*c6d7a45dSGunnar Mills    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TelemetryData.v1_0_0">
67*c6d7a45dSGunnar Mills      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
68*c6d7a45dSGunnar Mills      <Annotation Term="Redfish.Release" String="2025.2"/>
69*c6d7a45dSGunnar Mills
70*c6d7a45dSGunnar Mills      <EntityType Name="TelemetryData" BaseType="TelemetryData.TelemetryData">
71*c6d7a45dSGunnar Mills        <Property Name="Timestamp" Type="Edm.DateTimeOffset">
72*c6d7a45dSGunnar Mills          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
73*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The date and time when the telemetry data was generated."/>
74*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the time when the telemetry data was generated."/>
75*c6d7a45dSGunnar Mills        </Property>
76*c6d7a45dSGunnar Mills        <Property Name="TelemetryDataType" Type="TelemetryData.TelemetryDataTypes">
77*c6d7a45dSGunnar Mills          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
78*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The type of telemetry data available in the `AdditionalData` property or retrieved from the URI specified by the `AdditionalDataURI` property."/>
79*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the type of telemetry data available in the `AdditionalData` property or retrieved from the URI specified by the `AdditionalDataURI` property."/>
80*c6d7a45dSGunnar Mills        </Property>
81*c6d7a45dSGunnar Mills        <Property Name="OEMTelemetryDataType" Type="Edm.String">
82*c6d7a45dSGunnar Mills          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
83*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The OEM-defined type of telemetry data available in the `AdditionalData` property or retrieved from the URI specified by the `AdditionalDataURI` property."/>
84*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the OEM-defined type of telemetry data available in the `AdditionalData` property or retrieved from the URI specified by the `AdditionalDataURI` property.  The value of this property should begin with the organization identifier.  This property shall be present if `TelemetryDataType` is `OEM`."/>
85*c6d7a45dSGunnar Mills        </Property>
86*c6d7a45dSGunnar Mills        <Property Name="AdditionalData" Type="Edm.String" Nullable="false">
87*c6d7a45dSGunnar Mills          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
88*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="A Base64-encoded string of the associated telemetry data."/>
89*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain a Base64-encoded string, with padding characters, of the associated telemetry data.  The contents shall depend on the value of the `TelemetryDataType` property.  The length of the value should not exceed 4 KB.  Larger telemetry data payloads should omit this property and use the `AdditionalDataURI` property to reference the data.  If both `AdditionalData` and `AdditionalDataURI` are present, `AdditionalData` shall contain the Base64-encoding of the data retrieved from the URI specified by the `AdditionalDataURI` property."/>
90*c6d7a45dSGunnar Mills        </Property>
91*c6d7a45dSGunnar Mills        <Property Name="AdditionalDataURI" Type="Edm.String" Nullable="false">
92*c6d7a45dSGunnar Mills          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
93*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The URI at which to access the associated telemetry data."/>
94*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the URI at which to access the associated telemetry data, using the Redfish protocol and authentication methods.  If both `AdditionalData` and `AdditionalDataURI` are present, `AdditionalData` shall contain a Base64-encoded string, with padding characters, of the data retrieved from the URI specified by the `AdditionalDataURI` property."/>
95*c6d7a45dSGunnar Mills          <Annotation Term="OData.IsURL"/>
96*c6d7a45dSGunnar Mills        </Property>
97*c6d7a45dSGunnar Mills        <Property Name="AdditionalDataSizeBytes" Type="Edm.Int64">
98*c6d7a45dSGunnar Mills          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
99*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The size of the data available at location specified by `AdditionalDataURI`."/>
100*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the size of the data available at location specified by `AdditionalDataURI`:."/>
101*c6d7a45dSGunnar Mills        </Property>
102*c6d7a45dSGunnar Mills        <Property Name="Actions" Type="TelemetryData.v1_0_0.Actions" Nullable="false">
103*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The available actions for this resource."/>
104*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
105*c6d7a45dSGunnar Mills        </Property>
106*c6d7a45dSGunnar Mills      </EntityType>
107*c6d7a45dSGunnar Mills
108*c6d7a45dSGunnar Mills      <ComplexType Name="Actions">
109*c6d7a45dSGunnar Mills        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
110*c6d7a45dSGunnar Mills        <Annotation Term="OData.Description" String="The available actions for this resource."/>
111*c6d7a45dSGunnar Mills        <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
112*c6d7a45dSGunnar Mills        <Property Name="Oem" Type="TelemetryData.v1_0_0.OemActions" Nullable="false">
113*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
114*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
115*c6d7a45dSGunnar Mills        </Property>
116*c6d7a45dSGunnar Mills      </ComplexType>
117*c6d7a45dSGunnar Mills
118*c6d7a45dSGunnar Mills      <ComplexType Name="OemActions">
119*c6d7a45dSGunnar Mills        <Annotation Term="OData.AdditionalProperties" Bool="true"/>
120*c6d7a45dSGunnar Mills        <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
121*c6d7a45dSGunnar Mills        <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
122*c6d7a45dSGunnar Mills      </ComplexType>
123*c6d7a45dSGunnar Mills    </Schema>
124*c6d7a45dSGunnar Mills
125*c6d7a45dSGunnar Mills  </edmx:DataServices>
126*c6d7a45dSGunnar Mills</edmx:Edmx>
127