xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema/TelemetryData.v1_0_0.json (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)

{
    "$id": "http://redfish.dmtf.org/schemas/v1/TelemetryData.v1_0_0.json",
    "$ref": "#/definitions/TelemetryData",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
    "definitions": {
        "Actions": {
            "additionalProperties": false,
            "description": "The available actions for this resource.",
            "longDescription": "This type shall contain the available actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "Oem": {
                    "$ref": "#/definitions/OemActions",
                    "description": "The available OEM-specific actions for this resource.",
                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
                }
            },
            "type": "object"
        },
        "OemActions": {
            "additionalProperties": true,
            "description": "The available OEM-specific actions for this resource.",
            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {},
            "type": "object"
        },
        "TelemetryData": {
            "additionalProperties": false,
            "description": "The `TelemetryData` schema represents bulk telemetry data from a device or service.",
            "longDescription": "This resource shall represent bulk telemetry data in a Redfish implementation.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "@odata.context": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
                },
                "@odata.etag": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
                },
                "@odata.id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
                },
                "@odata.type": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
                },
                "Actions": {
                    "$ref": "#/definitions/Actions",
                    "description": "The available actions for this resource.",
                    "longDescription": "This property shall contain the available actions for this resource."
                },
                "AdditionalData": {
                    "description": "A Base64-encoded string of the associated telemetry data.",
                    "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.",
                    "readonly": true,
                    "type": "string"
                },
                "AdditionalDataSizeBytes": {
                    "description": "The size of the data available at location specified by `AdditionalDataURI`.",
                    "longDescription": "This property shall contain the size of the data available at location specified by `AdditionalDataURI`:.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "AdditionalDataURI": {
                    "description": "The URI at which to access the associated telemetry data.",
                    "format": "uri-reference",
                    "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.",
                    "readonly": true,
                    "type": "string"
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
                    "readonly": true
                },
                "OEMTelemetryDataType": {
                    "description": "The OEM-defined type of telemetry data available in the `AdditionalData` property or retrieved from the URI specified by the `AdditionalDataURI` property.",
                    "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`.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
                },
                "TelemetryDataType": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/TelemetryData.json#/definitions/TelemetryDataTypes"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The type of telemetry data available in the `AdditionalData` property or retrieved from the URI specified by the `AdditionalDataURI` property.",
                    "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.",
                    "readonly": true
                },
                "Timestamp": {
                    "description": "The date and time when the telemetry data was generated.",
                    "format": "date-time",
                    "longDescription": "This property shall contain the time when the telemetry data was generated.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2025.2",
    "title": "#TelemetryData.v1_0_0.TelemetryData"
}