xref: /openbmc/bmcweb/redfish-core/schema/dmtf/json-schema/TelemetryData.v1_0_0.json (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)
1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/TelemetryData.v1_0_0.json",
3    "$ref": "#/definitions/TelemetryData",
4    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5    "copyright": "Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
6    "definitions": {
7        "Actions": {
8            "additionalProperties": false,
9            "description": "The available actions for this resource.",
10            "longDescription": "This type shall contain the available actions for this resource.",
11            "patternProperties": {
12                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
13                    "description": "This property shall specify a valid odata or Redfish property.",
14                    "type": [
15                        "array",
16                        "boolean",
17                        "integer",
18                        "number",
19                        "null",
20                        "object",
21                        "string"
22                    ]
23                }
24            },
25            "properties": {
26                "Oem": {
27                    "$ref": "#/definitions/OemActions",
28                    "description": "The available OEM-specific actions for this resource.",
29                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
30                }
31            },
32            "type": "object"
33        },
34        "OemActions": {
35            "additionalProperties": true,
36            "description": "The available OEM-specific actions for this resource.",
37            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
38            "patternProperties": {
39                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
40                    "description": "This property shall specify a valid odata or Redfish property.",
41                    "type": [
42                        "array",
43                        "boolean",
44                        "integer",
45                        "number",
46                        "null",
47                        "object",
48                        "string"
49                    ]
50                }
51            },
52            "properties": {},
53            "type": "object"
54        },
55        "TelemetryData": {
56            "additionalProperties": false,
57            "description": "The `TelemetryData` schema represents bulk telemetry data from a device or service.",
58            "longDescription": "This resource shall represent bulk telemetry data in a Redfish implementation.",
59            "patternProperties": {
60                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
61                    "description": "This property shall specify a valid odata or Redfish property.",
62                    "type": [
63                        "array",
64                        "boolean",
65                        "integer",
66                        "number",
67                        "null",
68                        "object",
69                        "string"
70                    ]
71                }
72            },
73            "properties": {
74                "@odata.context": {
75                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
76                },
77                "@odata.etag": {
78                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
79                },
80                "@odata.id": {
81                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
82                },
83                "@odata.type": {
84                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
85                },
86                "Actions": {
87                    "$ref": "#/definitions/Actions",
88                    "description": "The available actions for this resource.",
89                    "longDescription": "This property shall contain the available actions for this resource."
90                },
91                "AdditionalData": {
92                    "description": "A Base64-encoded string of the associated telemetry data.",
93                    "longDescription": "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.",
94                    "readonly": true,
95                    "type": "string"
96                },
97                "AdditionalDataSizeBytes": {
98                    "description": "The size of the data available at location specified by `AdditionalDataURI`.",
99                    "longDescription": "This property shall contain the size of the data available at location specified by `AdditionalDataURI`:.",
100                    "readonly": true,
101                    "type": [
102                        "integer",
103                        "null"
104                    ]
105                },
106                "AdditionalDataURI": {
107                    "description": "The URI at which to access the associated telemetry data.",
108                    "format": "uri-reference",
109                    "longDescription": "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.",
110                    "readonly": true,
111                    "type": "string"
112                },
113                "Description": {
114                    "anyOf": [
115                        {
116                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
117                        },
118                        {
119                            "type": "null"
120                        }
121                    ],
122                    "readonly": true
123                },
124                "Id": {
125                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
126                    "readonly": true
127                },
128                "Name": {
129                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
130                    "readonly": true
131                },
132                "OEMTelemetryDataType": {
133                    "description": "The OEM-defined type of telemetry data available in the `AdditionalData` property or retrieved from the URI specified by the `AdditionalDataURI` property.",
134                    "longDescription": "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`.",
135                    "readonly": true,
136                    "type": [
137                        "string",
138                        "null"
139                    ]
140                },
141                "Oem": {
142                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
143                    "description": "The OEM extension property.",
144                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
145                },
146                "TelemetryDataType": {
147                    "anyOf": [
148                        {
149                            "$ref": "http://redfish.dmtf.org/schemas/v1/TelemetryData.json#/definitions/TelemetryDataTypes"
150                        },
151                        {
152                            "type": "null"
153                        }
154                    ],
155                    "description": "The type of telemetry data available in the `AdditionalData` property or retrieved from the URI specified by the `AdditionalDataURI` property.",
156                    "longDescription": "This property shall contain the type of telemetry data available in the `AdditionalData` property or retrieved from the URI specified by the `AdditionalDataURI` property.",
157                    "readonly": true
158                },
159                "Timestamp": {
160                    "description": "The date and time when the telemetry data was generated.",
161                    "format": "date-time",
162                    "longDescription": "This property shall contain the time when the telemetry data was generated.",
163                    "readonly": true,
164                    "type": [
165                        "string",
166                        "null"
167                    ]
168                }
169            },
170            "required": [
171                "@odata.id",
172                "@odata.type",
173                "Id",
174                "Name"
175            ],
176            "type": "object"
177        }
178    },
179    "language": "en",
180    "owningEntity": "DMTF",
181    "release": "2025.2",
182    "title": "#TelemetryData.v1_0_0.TelemetryData"
183}