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