{
  "name": "AlarmNotification",
  "description": "Information of a VNF alarm.\n",
  "in": "body",
  "required": true,
  "schema": {
    "description": "This type represents an alarm notification about VNF faults. This notification shall be triggered by the VNFM when: * An alarm has been created. * An alarm has been updated, e.g. if the severity of the alarm has  changed.\n",
    "type": "object",
    "required": [
      "id",
      "notificationType",
      "subscriptionId",
      "timeStamp",
      "alarm",
      "_links"
    ],
    "properties": {
      "id": {
        "description": "An identifier with the intention of being globally unique.\n",
        "type": "string"
      },
      "notificationType": {
        "description": "Discriminator for the different notification types. Shall be set to \"AlarmNotification\" for this notification type.\n",
        "type": "string",
        "enum": [
          "AlarmNotification"
        ]
      },
      "subscriptionId": {
        "description": "An identifier with the intention of being globally unique.\n",
        "type": "string"
      },
      "timeStamp": {
        "description": "Date-time stamp.  Representation: String formatted according to IETF RFC 3339.\n",
        "type": "string",
        "format": "date-time"
      },
      "alarm": {
        "description": "The alarm data type encapsulates information about an alarm.\n",
        "type": "object",
        "required": [
          "id",
          "managedObjectId",
          "rootCauseFaultyResource",
          "alarmRaisedTime",
          "ackState",
          "perceivedSeverity",
          "eventTime",
          "eventType",
          "probableCause",
          "isRootCause",
          "_links"
        ],
        "properties": {
          "id": {
            "description": "An identifier with the intention of being globally unique.\n",
            "type": "string"
          },
          "managedObjectId": {
            "description": "An identifier with the intention of being globally unique.\n",
            "type": "string"
          },
          "rootCauseFaultyResource": {
            "description": "This type represents the faulty virtual resources that have a negative impact on a VNF.\n",
            "type": "object",
            "required": [
              "faultyResource",
              "faultyResourceType"
            ],
            "properties": {
              "faultyResource": {
                "required": [
                  "vimConnectionId",
                  "resourceId"
                ],
                "type": "object",
                "description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance. Information about the resource is available from the VIM.\n",
                "properties": {
                  "vimConnectionId": {
                    "description": "An identifier with the intention of being globally unique.\n",
                    "type": "string"
                  },
                  "resourceProviderId": {
                    "description": "An identifier with the intention of being globally unique.\n",
                    "type": "string"
                  },
                  "resourceId": {
                    "description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance.\n",
                    "type": "string"
                  },
                  "vimLevelResourceType": {
                    "description": "Type of the resource in the scope of the VIM or the resource provider.\n",
                    "type": "string"
                  }
                }
              },
              "faultyResourceType": {
                "description": "The enumeration FaultyResourceType represents those types of faulty resource.\n",
                "type": "string",
                "enum": [
                  "COMPUTE",
                  "STORAGE",
                  "NETWORK"
                ]
              }
            }
          },
          "alarmRaisedTime": {
            "description": "Date-time stamp.  Representation: String formatted according to IETF RFC 3339.\n",
            "type": "string",
            "format": "date-time"
          },
          "alarmChangedTime": {
            "description": "Date-time stamp.  Representation: String formatted according to IETF RFC 3339.\n",
            "type": "string",
            "format": "date-time"
          },
          "alarmClearedTime": {
            "description": "Date-time stamp.  Representation: String formatted according to IETF RFC 3339.\n",
            "type": "string",
            "format": "date-time"
          },
          "ackState": {
            "description": "Acknowledgement state of the alarm.  Permitted values: * UNACKNOWLEDGED * ACKNOWLEDGED.\n",
            "type": "string",
            "enum": [
              "UNACKNOWLEDGED",
              "ACKNOWLEDGED"
            ]
          },
          "perceivedSeverity": {
            "description": "Indicates the relative level of urgency for operator attention. * CRITICAL: The Critical severity level indicates that a service  affecting condition has occurred and an immediate corrective action\n  is required. Such a severity can be reported, for example, when a\n  managed object becomes totally out of service and its capability needs\n  to be restored (ITU-T Recommendation X.733).\n* MAJOR: The Major severity level indicates that a service affecting  condition has developed and an urgent corrective action is required.\n  Such a severity can be reported, for example, when there is a severe\n  degradation in the capability of the managed object and its full\n  capability needs to be restored (ITU-T Recommendation X.733).\n* MINOR: The Minor severity level indicates the existence of a  non-service affecting fault condition and that corrective action\n  should be taken in order to prevent a more serious (for example,\n  service affecting) fault. Such a severity can be reported, for\n  example, when the detected alarm condition is not currently degrading\n  the capacity of the managed object (ITU-T Recommendation X.733).\n* WARNING: The Warning severity level indicates the detection of a  potential or impending service affecting fault, before any significant\n  effects have been felt. Action should be taken to further diagnose (if\n  necessary) and correct the problem in order to prevent it from\n  becoming a more serious service affecting fault (ITU-T Recommendation\n  X.733).\n* INDETERMINATE: The Indeterminate severity level indicates that the  severity level cannot be determined (ITU-T Recommendation X.733).\n* CLEARED: The Cleared severity level indicates the clearing of one or  more previously reported alarms. This alarm clears all alarms for this\n  managed object that have the same Alarm type, Probable cause and\n  Specific problems (if given) (ITU-T Recommendation X.733).\n",
            "type": "string",
            "enum": [
              "CRITICAL",
              "MAJOR",
              "MINOR",
              "WARNING",
              "INDETERMINATE",
              "CLEARED"
            ]
          },
          "eventTime": {
            "description": "Date-time stamp.  Representation: String formatted according to IETF RFC 3339.\n",
            "type": "string",
            "format": "date-time"
          },
          "eventType": {
            "description": "The enumeration EventType represents those types of events that trigger an alarm. * COMMUNICATIONS_ALARM: An alarm of this type is associated with the  procedure and/or process required conveying information from one point\n  to another (ITU-T Recommendation X.733).\n* PROCESSING_ERROR_ALARM: An alarm of this type is associated with a  software or processing fault (ITU-T Recommendation X.733).\n* ENVIRONMENTAL_ALARM: An alarm of this type is associated with a  condition related to an enclosure in which the equipment resides\n  (ITU-T Recommendation X.733).\n* QOS_ALARM: An alarm of this type is associated with degradation in the  quality of a service (ITU-T Recommendation X.733).\n* EQUIPMENT_ALARM: An alarm of this type is associated with an equipment  fault (ITU-T Recommendation X.733).\n",
            "type": "string",
            "enum": [
              "COMMUNICATIONS_ALARM",
              "PROCESSING_ERROR_ALARM",
              "ENVIRONMENTAL_ALARM",
              "QOS_ALARM",
              "EQUIPMENT_ALARM"
            ]
          },
          "faultType": {
            "description": "Additional information to clarify the type of the fault.\n",
            "type": "string"
          },
          "probableCause": {
            "description": "Information about the probable cause of the fault.\n",
            "type": "string"
          },
          "isRootCause": {
            "description": "Attribute indicating if this fault is the root for other correlated alarms. If TRUE, then the alarms listed in the attribute CorrelatedAlarmId are caused by this fault.\n",
            "type": "boolean"
          },
          "correlatedAlarmIds": {
            "description": "List of identifiers of other alarms correlated to this fault.\n",
            "type": "array",
            "items": {
              "description": "An identifier with the intention of being globally unique.\n",
              "type": "string"
            }
          },
          "faultDetails": {
            "description": "Provides additional information about the fault.\n",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "_links": {
            "description": "Links for this resource.\n",
            "type": "object",
            "required": [
              "self"
            ],
            "properties": {
              "self": {
                "description": "This type represents a link to a resource.\n",
                "type": "object",
                "required": [
                  "href"
                ],
                "properties": {
                  "href": {
                    "description": "URI of the referenced resource.\n",
                    "type": "string",
                    "format": "url"
                  }
                }
              },
              "objectInstance": {
                "description": "This type represents a link to a resource.\n",
                "type": "object",
                "required": [
                  "href"
                ],
                "properties": {
                  "href": {
                    "description": "URI of the referenced resource.\n",
                    "type": "string",
                    "format": "url"
                  }
                }
              }
            }
          }
        }
      },
      "_links": {
        "description": "Links to resources related to this notification.\n",
        "type": "object",
        "required": [
          "subscription"
        ],
        "properties": {
          "subscription": {
            "description": "This type represents a link to a resource.\n",
            "type": "object",
            "required": [
              "href"
            ],
            "properties": {
              "href": {
                "description": "URI of the referenced resource.\n",
                "type": "string",
                "format": "url"
              }
            }
          }
        }
      }
    }
  }
}