static/redfish/v1/JsonSchemas/Event/Event.json

{
    "$id": "http://redfish.dmtf.org/schemas/v1/Event.v1_6_0.json",
    "$ref": "#/definitions/Event",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2020 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"
        },
        "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"
                },
                "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"
                },
                "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 indicate a unique identifier for the event.  The value should be a string of a positive integer, and should be generated in a sequential manner.",
                    "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"
                },
                "MemberId": {
                    "description": "The identifier for the member within the collection.",
                    "longDescription": "This property shall uniquely identify the member within the collection.  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.",
                    "readonly": true,
                    "type": "array"
                },
                "MessageId": {
                    "description": "The key used to find the message in a message registry.",
                    "longDescription": "This property shall contain a MessageId, as defined in the Redfish Specification.",
                    "pattern": "^[A-Za-z0-9]+\\.\\d+\\.\\d+\\.[A-Za-z0-9.]+$",
                    "readonly": true,
                    "type": "string"
                },
                "MessageSeverity": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Health"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "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"
                },
                "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.",
                    "readonly": true
                },
                "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 by 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"
                }
            },
            "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"
        }
    },
    "owningEntity": "DMTF",
    "release": "2020.3",
    "title": "#Event.v1_6_0.Event"
}