xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema/Event.v1_11_1.json (revision d125652e8a30dfeaad88bbfa5b1e04a80610469c)

{
    "$id": "http://redfish.dmtf.org/schemas/v1/Event.v1_11_1.json",
    "$ref": "#/definitions/Event",
    "$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.",
                    "versionAdded": "v1_2_0"
                }
            },
            "type": "object"
        },
        "CPER": {
            "additionalProperties": false,
            "description": "Details for a CPER section or record associated with an event.",
            "longDescription": "This object shall contain the details for a CPER section or record that is the source of an event.",
            "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": {
                "NotificationType": {
                    "description": "The CPER Notification Type for a CPER record.",
                    "longDescription": "This property shall contain the CPER Notification Type for a CPER record that corresponds to the contents of the `DiagnosticData` property or data retrieved from the URI specified by the `AdditionalDataURI` property.  This property shall only be present if `DiagnosticDataType` contains `CPER`.",
                    "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_8_0"
                },
                "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 contained in this object shall conform to the Redfish Specification-described requirements.",
                    "versionAdded": "v1_8_0"
                },
                "SectionType": {
                    "description": "The CPER Section Type.",
                    "longDescription": "This property shall contain the CPER Section Type for a CPER section that corresponds to the contents of the `DiagnosticData` property or data retrieved from the URI specified by the `AdditionalDataURI` property.  This property shall only be present if `DiagnosticDataType` contains `CPERSection`.",
                    "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_8_0"
                }
            },
            "type": "object"
        },
        "DiagnosticDataTypes": {
            "enum": [
                "Manager",
                "PreOS",
                "OS",
                "OEM",
                "CPER",
                "CPERSection"
            ],
            "enumDescriptions": {
                "CPER": "UEFI Common Platform Error Record.",
                "CPERSection": "A Section of a UEFI Common Platform Error Record.",
                "Manager": "Manager diagnostic data.",
                "OEM": "OEM diagnostic data.",
                "OS": "Operating system (OS) diagnostic data.",
                "PreOS": "Pre-OS diagnostic data."
            },
            "enumLongDescriptions": {
                "CPER": "This value shall indicate the data provided at the URI specified by the `AdditionalDataURI` property is a complete UEFI Specification-defined Common Platform Error Record.  The CPER data shall contain a Record Header and at least one Section as defined by the UEFI Specification.",
                "CPERSection": "This value shall indicate the data provided at the URI specified by the `AdditionalDataURI` property is a single Section of a UEFI Specification-defined Common Platform Error Record.  The CPER data shall contain one Section as defined by the UEFI Specification, with no Record Header."
            },
            "type": "string"
        },
        "Event": {
            "additionalProperties": false,
            "description": "The `Event` schema describes the JSON payload received by an event destination, which has subscribed to event notification, when events occur.  This resource contains data about events, including descriptions, severity, and a message identifier to a message registry that can be accessed for further information.",
            "longDescription": "This resource contains an event for 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.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.",
                    "versionAdded": "v1_2_0"
                },
                "Context": {
                    "description": "A context can be supplied at subscription time.  This property is the context value supplied by the subscriber.",
                    "longDescription": "This property shall contain a client supplied context for the event destination to which this event is being sent.",
                    "readonly": true,
                    "type": "string",
                    "versionAdded": "v1_1_0"
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "Events": {
                    "autoExpand": true,
                    "description": "Each event in this array has a set of properties that describe the event.  Because this is an array, more than one event can be sent simultaneously.",
                    "items": {
                        "$ref": "#/definitions/EventRecord"
                    },
                    "longDescription": "This property shall contain an array of objects that represent the occurrence of one or more events.",
                    "type": "array"
                },
                "Events@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "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
                },
                "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."
                }
            },
            "required": [
                "Events",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        },
        "EventRecord": {
            "additionalProperties": false,
            "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": {
                "Actions": {
                    "$ref": "#/definitions/EventRecordActions",
                    "description": "The available actions for this resource.",
                    "longDescription": "This property shall contain the available actions for this resource.",
                    "versionAdded": "v1_2_0"
                },
                "AdditionalDataSizeBytes": {
                    "description": "The size of the additional data for this event.",
                    "longDescription": "This property shall contain the size of the additional data retrieved from the URI specified by the `AdditionalDataURI` property for this event.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "By",
                    "versionAdded": "v1_8_0"
                },
                "AdditionalDataURI": {
                    "description": "The URI at which to access the additional data for the event, such as diagnostic data, image captures, or other files.",
                    "format": "uri-reference",
                    "longDescription": "This property shall contain the URI at which to access the additional data for the event, using the Redfish protocol and authentication methods.  If both `DiagnosticData` and `AdditionalDataURI` are present, `DiagnosticData` 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",
                        "null"
                    ],
                    "versionAdded": "v1_8_0"
                },
                "CPER": {
                    "$ref": "#/definitions/CPER",
                    "description": "Details for a CPER section or record associated with this event.",
                    "longDescription": "This property shall contain the details for a CPER section or record that is the source of this event.",
                    "versionAdded": "v1_8_0"
                },
                "Context": {
                    "deprecated": "Events are triggered independently from subscriptions to those events.  This property has been deprecated in favor of the `Context` property found at the root level of the object.",
                    "description": "A context can be supplied at subscription time.  This property is the context value supplied by the subscriber.",
                    "longDescription": "This property shall contain a client supplied context for the event destination to which this event is being sent.",
                    "readonly": true,
                    "type": "string",
                    "versionDeprecated": "v1_1_0"
                },
                "DiagnosticData": {
                    "description": "A Base64-encoded set of diagnostic data associated with this event.",
                    "longDescription": "This property shall contain a Base64-encoded string, with padding characters, that represents the diagnostic data associated with this event.  The contents shall depend on the value of the `DiagnosticDataType` property.  The length of the value should not exceed 4 KB.  Larger diagnostic data payloads should omit this property and use the `AdditionalDataURI` property to reference the data.  If both `DiagnosticData` and `AdditionalDataURI` are present, `DiagnosticData` shall contain the Base64-encoding of the data retrieved from the URI specified by the `AdditionalDataURI` property.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_8_0"
                },
                "DiagnosticDataType": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/DiagnosticDataTypes"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The type of data available in the `DiagnosticData` property or retrieved from the URI specified by the `AdditionalDataURI` property.",
                    "longDescription": "This property shall contain the type of data available in the `DiagnosticData` property or retrieved from the URI specified by the `AdditionalDataURI` property.",
                    "readonly": true,
                    "versionAdded": "v1_8_0"
                },
                "EventGroupId": {
                    "description": "The identifier that correlates events with the same root cause.  If `0`, no other event is related to this event.",
                    "longDescription": "This property shall indicate that events are related and shall have the same value when multiple event messages are produced by the same root cause.  Implementations shall use separate values for events with a separate root cause.  This property value shall not imply an ordering of events.  The `0` value shall indicate that this event is not grouped with any other event.",
                    "readonly": true,
                    "type": "integer",
                    "versionAdded": "v1_3_0"
                },
                "EventId": {
                    "description": "The unique instance identifier of an event.",
                    "longDescription": "This property shall contain a service-defined unique identifier for the event.",
                    "readonly": true,
                    "type": "string"
                },
                "EventTimestamp": {
                    "description": "The time the event occurred.",
                    "format": "date-time",
                    "longDescription": "This property shall indicate the time the event occurred where the value shall be consistent with the Redfish service time that is also used for the values of the `Modified` property.",
                    "readonly": true,
                    "type": "string"
                },
                "EventType": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Event.json#/definitions/EventType",
                    "deprecated": "This property has been deprecated.  Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the `RegistryPrefix` and `ResourceType` properties and not on the `EventType` property.",
                    "description": "The type of event.",
                    "longDescription": "This property shall indicate the type of event.",
                    "readonly": true,
                    "versionDeprecated": "v1_3_0"
                },
                "LogEntry": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/LogEntry.json#/definitions/LogEntry",
                    "description": "The link to a log entry if an entry was created for this event.",
                    "longDescription": "This property shall contain a link to a resource of type `LogEntry` that represents the log entry created for this event.",
                    "readonly": true,
                    "versionAdded": "v1_7_0"
                },
                "MemberId": {
                    "description": "The unique identifier for the member within an array.",
                    "longDescription": "This property shall contain the unique identifier for this member within an array.  For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.",
                    "readonly": true,
                    "type": "string"
                },
                "Message": {
                    "description": "The human-readable event message.",
                    "longDescription": "This property shall contain a human-readable event message.",
                    "readonly": true,
                    "type": "string"
                },
                "MessageArgs": {
                    "description": "An array of message arguments that are substituted for the arguments in the message when looked up in the message registry.",
                    "items": {
                        "type": "string"
                    },
                    "longDescription": "This property shall contain an array of message arguments that are substituted for the arguments in the message when looked up in the message registry.  It has the same semantics as the `MessageArgs` property in the Redfish `MessageRegistry` schema.  If the corresponding `ParamType` value contains `number`, the service shall convert the number to a string representation of the number.",
                    "readonly": true,
                    "type": "array"
                },
                "MessageId": {
                    "description": "The identifier for the message.",
                    "longDescription": "This property shall contain a `MessageId`, as defined in the 'MessageId format' clause of the Redfish Specification.",
                    "pattern": "^[A-Za-z0-9]+\\.\\d+\\.\\d+\\.[A-Za-z0-9.]+$",
                    "readonly": true,
                    "type": "string"
                },
                "MessageSeverity": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Health",
                    "description": "The severity of the message in this event.",
                    "longDescription": "This property shall contain the severity of the message in this event.  Services can replace the value defined in the message registry with a value more applicable to the implementation.",
                    "readonly": true,
                    "versionAdded": "v1_5_0"
                },
                "OEMDiagnosticDataType": {
                    "description": "The OEM-defined type of data available in the `DiagnosticData` property or retrieved from the URI specified by the `AdditionalDataURI` property.",
                    "longDescription": "This property shall contain the OEM-defined type of data available in the `DiagnosticData` property or retrieved from the URI specified by the `AdditionalDataURI` property.  This property shall be present if `DiagnosticDataType` is `OEM`.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_9_0"
                },
                "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."
                },
                "OriginOfCondition": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef",
                    "description": "A link to the resource or object that originated the condition that caused the event to be generated.",
                    "longDescription": "This property shall contain a link to the resource or object that originated the condition that caused the event to be generated.  If the event subscription has the `IncludeOriginOfCondition` property set to `true`, it shall include the entire resource or object referenced by the link.  For events that represent the creation or deletion of a resource, this property should reference the created or deleted resource and not the collection that contains the resource.",
                    "readonly": true
                },
                "Resolution": {
                    "description": "Used to provide suggestions on how to resolve the situation that caused the event.",
                    "longDescription": "This property shall contain the resolution of the event.  Services should replace the resolution defined in the message registry with a more specific resolution in the event.",
                    "readonly": true,
                    "type": "string",
                    "versionAdded": "v1_9_0"
                },
                "ResolutionSteps": {
                    "description": "The list of recommended steps to resolve the cause of the event.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/ResolutionStep.json#/definitions/ResolutionStep"
                    },
                    "longDescription": "This property shall contain an array of recommended steps to resolve the cause of the event.  This property shall not be present if the `MessageSeverity` or `Severity` properties contain `OK`.  A client can stop executing the resolution steps once the `Resolved` property in the associated `LogEntry` resource contains `true` or the `Health` property in the associated resource referenced by the `OriginOfCondition` property contains `OK`.",
                    "type": "array",
                    "versionAdded": "v1_10_0"
                },
                "Severity": {
                    "deprecated": "This property has been deprecated in favor of `MessageSeverity`, which ties the values to the enumerations defined for the `Health` property within `Status`.",
                    "description": "The severity of the event.",
                    "longDescription": "This property shall contain the severity of the event, as defined in the 'Status' clause of the Redfish Specification.  Services can replace the value defined in the message registry with a value more applicable to the implementation.",
                    "readonly": true,
                    "type": "string",
                    "versionDeprecated": "v1_5_0"
                },
                "SpecificEventExistsInGroup": {
                    "description": "Indicates this event is equivalent to a more specific event in this event group.",
                    "longDescription": "This property shall indicate that the event is equivalent to another event, with a more specific definition, within the same `EventGroupId`.  For example, the `DriveFailed` message from the Storage Device Message Registry is more specific than the `ResourceStatusChangedCritical` message from the Resource Event Message Registry, when both occur with the same `EventGroupId`.  This property shall contain `true` if a more specific event is available, and shall contain `false` if no equivalent event exists in the same `EventGroupId`.  If this property is absent, the value shall be assumed to be `false`.",
                    "readonly": true,
                    "type": "boolean",
                    "versionAdded": "v1_6_0"
                },
                "UserAuthenticationSource": {
                    "description": "The source of authentication for the username property associated with the event record.",
                    "longDescription": "This property shall contain the URL to the authentication service that is associated with the username property.  This should be used for events that result from a user action.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_11_0"
                },
                "Username": {
                    "description": "The username of the account associated with the event record.",
                    "longDescription": "This property shall contain the username of the account associated with the event record.  This should be used for events that result from a user action.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ],
                    "versionAdded": "v1_11_0"
                }
            },
            "required": [
                "EventType",
                "MessageId",
                "MemberId"
            ],
            "type": "object"
        },
        "EventRecordActions": {
            "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/EventRecordOemActions",
                    "description": "The available OEM-specific actions for this resource.",
                    "longDescription": "This property shall contain the available OEM-specific actions for this resource.",
                    "versionAdded": "v1_2_0"
                }
            },
            "type": "object"
        },
        "EventRecordOemActions": {
            "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"
        },
        "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"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2024.3",
    "title": "#Event.v1_11_1.Event"
}