MEF
MEF LSO Interlude Alarm Notification

Alarm Notification — the OpenAPI definition published by Mplify (formerly MEF) in the MEF LSO Interlude SDK, Kylie release. LSO Interlude is the Interface Reference Point between two Service Providers, covering inter-provider operational/service automation. 4 path(s), 4 operation(s). Apache-2.0 licensed and openly downloadable from public GitHub.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.1
info:
  title: Alarm Notification
  description: |
    **This file forms part of Mplify 146**

    This API implements Business Requirements described in Mplify 133.1

    This is the API to manage notifications for Alarms. This API must be
    deployed on notification subscriber side (buyer side / listener).

    List of supported use cases:
      - Send Alarm Notification

    Copyright 2025 Mplify Alliance and its contributors.

    This file includes content based on the TM Forum Alarm Management API
    (TMF642 v5.0.0) available at
    https://www.tmforum.org/oda/open-apis/directory/alarm-management-api-TMF642/v5.0,
    which is licensed by the TM Forum under the Apache License version 2.0.
    Such content has been modified by the Mplify Alliance and its contributors.
  version: 3.0.0
servers:
  - url: 'https://{serverBase}/mefApi/interlude/alarmNotification/v3/'
    variables:
      serverBase:
        description: The base of Buyer's URL.
        default: mplify.net
tags:
  - name: Notification listeners
    description: >
      The Buyer/Client's endpoint to send particular event types notifications
      to.
paths:
  /listener/alarmAttributeValueChangeEvent:
    post:
      tags:
        - Notification listeners
      summary: Alarm Attribute Value Change Notification endpoint
      description: This endpoint is used to receive alarm attribute value change notifications
      operationId: alarmCommentEvent
      requestBody:
        description: The event data
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AlarmEvent'
        required: true
      responses:
        '204':
          description: 'No Content (https://tools.ietf.org/html/rfc7231#section-6.3.5)'
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
  /listener/alarmCreateEvent:
    post:
      tags:
        - Notification listeners
      summary: Create Alarm Notification endpoint
      description: This endpoint is used to receive create alarm notifications 
      operationId: alarmCreateEvent
      requestBody:
        description: The event data
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AlarmEvent'
        required: true
      responses:
        '204':
          description: 'No Content (https://tools.ietf.org/html/rfc7231#section-6.3.5)'
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
  /listener/alarmDeleteEvent:
    post:
      tags:
        - Notification listeners
      summary: Delete Alarm Notification endpoint
      description: This endpoint is used to receive delete alarm notifications
      operationId: alarmDeleteEvent
      requestBody:
        description: The event data
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AlarmEvent'
        required: true
      responses:
        '204':
          description: 'No Content (https://tools.ietf.org/html/rfc7231#section-6.3.5)'
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
  /listener/alarmStateChangeEvent:
    post:
      tags:
        - Notification listeners
      summary: Alarm Attribute Change Notification endpoint
      description: This endpoint is used to receive alarm attribute change notifications
      operationId: alarmAcknowledgeEvent
      requestBody:
        description: The event data
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AlarmEvent'
        required: true
      responses:
        '204':
          description: 'No Content (https://tools.ietf.org/html/rfc7231#section-6.3.5)'
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
components:
  schemas:
    Alarm:
      allOf:
        - $ref: '#/components/schemas/Alarm_Common'
        - description: A definition of an Alarm.
          type: object
          properties:
            alarmedObject:
              description: >-
                Identifies the Managed Object instance associated with the
                alarm.
              type: array
              items:
                $ref: '#/components/schemas/AlarmedObjectRef'
            comment:
              type: array
              items:
                $ref: '#/components/schemas/Comment'
            externalAlarmId:
              description: An identifier of the alarm in the source system.
              type: string
            isRootCause:
              description: Indicates whether the alarm is a root cause alarm.
              type: boolean
            parentAlarm:
              $ref: '#/components/schemas/AlarmRef'
            probableCause:
              $ref: '#/components/schemas/ProbableCause'
            alarmSpecificAttributes:
              $ref: '#/components/schemas/AlarmSpecificAttributes'
            sourceSystemId:
              description: Source system identity.
              type: string
            specificProblem:
              description: Provides more specific information about the alarm.
              type: string
          required:
            - isRootCause
    AlarmEvent:
      allOf:
        - $ref: '#/components/schemas/Event'
        - type: object
          properties:
            eventType:
              description: |
                Indicates the type of the event.
              type: string
              enum:
              - alarmAttributeValueChangeEvent
            event:
              description: |
                A reference to the object that is source of the notification.
              $ref: '#/components/schemas/AlarmEventPayload'
          required:
            - event
            - eventType
    AlarmAttributeValueChangeEvent:
      allOf:
        - $ref: '#/components/schemas/Event'
        - type: object
          properties:
            eventType:
              description: |
                Indicates the type of the event.
              type: string
              enum:
              - alarmAttributeValueChangeEvent
            event:
              description: |
                A reference to the object that is source of the notification.
              $ref: '#/components/schemas/AlarmEventPayload'
          required:
            - event
            - eventType
    AlarmCreateEvent:
      allOf:
        - $ref: '#/components/schemas/Event'
        - type: object
          properties:
            eventType:
              description: |
                Indicates the type of the event.
              type: string
              enum:
              - alarmCreateEvent
            event:
              description: |
                A reference to the object that is source of the notification.
              $ref: '#/components/schemas/AlarmEventPayload'
          required:
            - event
            - eventType
    AlarmDeleteEvent:
      allOf:
        - $ref: '#/components/schemas/Event'
        - type: object
          properties:
            eventType:
              description: |
                Indicates the type of the event.
              type: string
              enum:
              - alarmDeleteEvent
            event:
              description: |
                A reference to the object that is source of the notification.
              $ref: '#/components/schemas/AlarmEventPayload'
          required:
            - event
            - eventType
    AlarmEventPayload:
      description: The identifier of the Test Job being subject of this event.
      type: object
      properties:
        alarm:
            $ref: '#/components/schemas/Alarm'
      required:
        - alarm
    AlarmedObjectRef:
      type: object
      properties:
        id:
          description: unique identifier of the Alarm
          type: string
        href:
          description: hyperlink to the referenced Alarm
          type: string
        '@referredType':
          description: >-
            The actual type of the target instance when needed for
            disambiguation.
          type: string
      required:
        - id
        - '@referredType'
    AlarmRef:
      type: object
      properties:
        id:
          description: unique identifier of the Alarm
          type: string
        href:
          description: hyperlink to the referenced Alarm
          type: string
      required:
        - id
    AlarmStateChangeEvent:
      allOf:
        - $ref: '#/components/schemas/Event'
        - type: object
          properties:
            eventType:
              description: |
                Indicates the type of the event.
              type: string
              enum:
              - alarmStateChangeEvent
            event:
              description: |
                A reference to the object that is source of the notification.
              $ref: '#/components/schemas/AlarmEventPayload'
          required:
            - event
            - eventType
    AlarmSpecificAttributes:
      description: >-
        AlarmSpecificAttributes is used as an extension for Alarm specific
        payload.  The @type attribute is used as a discriminator.
      type: object
      properties:
        '@type':
          description: The named type must be a subclass of AlarmSpecificAttributes.
          type: string
      required:
        - '@type'
      discriminator:
        propertyName: '@type'
    AlarmState:
      description: |- 
        Defines the alarm state during its life cycle.

        | state            | Mplify 133.1 name    |        Description                                                                                                                               |
        | ---------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
        | `acknowledged`   | Acknowledged    | An alarm that is still active but has been acknowledged by an operator, meaning the operator is aware of the issue and has taken note for action.|
        | `cleared`        | Cleared         | Indicates that the underlying fault or abnormal condition that triggered the alarm has been resolved, and the alarm is no longer active.         |
        | `unAcknowledged` | Unacknowledged  | An alarm that has been raised and is still visible to the operator, but has not yet been acknowledged.                                           |
      type: string
      enum:
        - acknowledged
        - cleared
        - unAcknowledged
    AlarmType:
      description: |-
        Categorize the alarm. Values as defined in X.733 8.1.1 or 3GPP TS32.111.

        | state                            | Mplify 133.1 name             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
        | -------------------------------- | -------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
        | `communicationsAlarm`            | Communications Alarm     | An alarm of this type is principally associated with the procedures and/or processes required to convey information from one point to another. |
        | `processingErrorAlarm`           | Processing Error Alarm   | An alarm of this type is principally associated with a software or processing fault.                                                           |
        | `environmentalAlarm`             | Environmental Alarm      | An alarm of this type is principally associated with a condition relating to an enclosure in which the equipment resides.                      |
        | `qualityOfServiceAlarm`          | Quality of Service Alarm | An alarm of this type is principally associated with a degradation in the quality of a service.                                                |
        | `equipmentAlarm`                 | Equipment Alarm          | An alarm of this type is principally associated with an equipment fault.                                                                       |
        | `communicationsAlarm`            | Communications Alarm     | An alarm of this type is principally associated with the procedures and/or processes required to convey information from one point to another. |
        | `processingErrorAlarm`           | Processing Error Alarm   | An alarm of this type is principally associated with a software or processing fault.                                                           |
        | `environmentalAlarm`             | Environmental Alarm      | An alarm of this type is principally associated with a condition relating to an enclosure in which the equipment resides.                      |
        | `qualityOfServiceAlarm`          | Quality of Service Alarm | An alarm of this type is principally associated with a degradation in the quality of a service.                                                |
        | `equipmentAlarm`                 | Equipment Alarm          | An alarm of this type is principally associated with an equipment fault.                                                                       |
        | `integrityViolation`             | Integrity Violation      | Information may have been illegally modified, inserted or deleted.                                                                             |
        | `operationalViolation`           | Operational Violation    | The unavailability, malfunction or incorrect invocation of a service.                                                                          |
        | `physicalViolation`              | Physical Violation       | A physical resource has been violated in a way that suggests a security attack.                                                                |
        | `securityService`                | Security Service         | A security attack has been detected by a security service.                                                                                     |
        | `mechanismViolation`             | Mechanism Violation      | A security attack has been detected by a security mechanism.                                                                                   |
        | `timeDomainViolation`            | Time Domain Violation    | An event has occurred at an unexpected or prohibited time.                                                                                     |
      type: string
      enum:
        - communicationsAlarm
        - processingErrorAlarm
        - environmentalAlarm
        - qualityOfServiceAlarm
        - equipmentAlarm
        - integrityViolation
        - operationalViolation
        - physicalViolation
        - securityService
        - mechanismViolation
        - timeDomainViolation
    Alarm_Common:
      description: A definition of an Alarm.
      type: object
      properties:
        id:
          description: The identifier of the Alarm.
          type: string
        href:
          description: Hyperlink reference
          type: string
          format: uri
        affectedService:
          description: Affected services
          type: array
          items:
            $ref: '#/components/schemas/ServiceRef'
        alarmChangedTime:
          description: >-
            Indicates the last date and time when the alarm is changed on the
            alarm  owning system. Any change to the alarm whether coming from
            the alarmed  resource is changing this time.
          type: string
          format: date-time
        alarmClearedTime:
          description: >-
            Indicates the time (as a date + time) at which the alarm is cleared
            at  the source.
          type: string
          format: date-time
        alarmDetails:
          description: Contains further information on the Alarm.
          type: string
        alarmedObjectType:
          description: >-
            The type (class) of the Managed Object associated with the event
            e.g. port.
          type: string
        alarmRaisedTime:
          description: >-
            The time that an alarm was raised.  This time may differ from the
            Alarm  Reported Time
          type: string
          format: date-time
        alarmReportingTime:
          description: >-
            Indicates the time (as a date + time) at which the alarm was
            reported by  the owning OSS. It might be different from the
            alarm-RaisedTime. For instance,  if the alarm list is maintained by
            an EMS, the alarmRaisedTime would be  the time the alarm was
            detected by the NE, while the alarmReportingTime  would be the time
            this alarm was stored in the alarm list of the EMS.
          type: string
          format: date-time
        correlatedAlarm:
          description: Correlated Alarms
          type: array
          items:
            $ref: '#/components/schemas/AlarmRef'
        alarmType:
          $ref: '#/components/schemas/AlarmType'
        perceivedSeverity:
          $ref: '#/components/schemas/PerceivedSeverity'
        plannedOutageIndicator:
          $ref: '#/components/schemas/PlannedOutageIndicator'
        reportingSystemId:
          description: Reporting system identity.
          type: string
        serviceAffecting:
          description: Indicates whether the alarm affects service or not.
          type: boolean
        state:
          $ref: '#/components/schemas/AlarmState'
      required:
        - alarmDetails
        - alarmRaisedTime
        - alarmReportingTime
        - alarmType
        - id
        - perceivedSeverity
        - state
        - serviceAffecting
    Comment:
      description: A comment entered on the alarm
      type: object
      properties:
        description:
          description: The text of the comment.
          type: string
        systemIdentifier:
          description: The system identifier of the system that set the comment.
          type: string
        time:
          description: The time commenting the alarm
          type: string
          format: date-time
        userIdentifier:
          description: The user commenting the alarm
          type: string
    Error:
      description: >
        Standard Class used to describe API response error Not intended to be
        used directly. The `code` in the HTTP header is used as a discriminator
        for the type of error returned in runtime.
      type: object
      properties:
        message:
          description: >-
            Text that provides mode details and corrective actions related to
            the error. This can be shown to a client user.
          type: string
        reason:
          description: >-
            Text that explains the reason for the error. This can be shown to a
            client user.
          type: string
          maxLength: 255
        referenceError:
          description: URL pointing to documentation describing the error
          type: string
          format: uri
      required:
        - reason
    Error400:
      description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)
      allOf:
        - $ref: "#/components/schemas/Error"
        - type: object
          properties:
            code:
              description: |
                One of the following error codes:
                - missingQueryParameter: The URI is missing a required
                query-string parameter
                - missingQueryValue: The URI is missing a required query-string
                parameter value
                - invalidQuery: The query section of the URI is invalid.
                - invalidBody: The request has an invalid body
              $ref: "#/components/schemas/Error400Code"
          required:
            - code
    Error400Code:
      description: |
        One of the following error codes:
        - missingQueryParameter: The URI is missing a required query-string
        parameter
        - missingQueryValue: The URI is missing a required query-string
        parameter value
        - invalidQuery: The query section of the URI is invalid.
        - invalidBody: The request has an invalid body
      type: string
      enum:
        - missingQueryParameter
        - missingQueryValue
        - invalidQuery
        - invalidBody
    Error401:
      description: Unauthorized.  (https://tools.ietf.org/html/rfc7235#section-3.1)
      allOf:
        - $ref: "#/components/schemas/Error"
        - type: object
          properties:
            code:
              description: |
                One of the following error codes:
                - missingCredentials: No credentials provided.
                - invalidCredentials: Provided credentials are invalid or
                expired
              $ref: "#/components/schemas/Error401Code"
          required:
            - code
    Error401Code:
      description: |
        One of the following error codes:
        - missingCredentials: No credentials provided.
        - invalidCredentials: Provided credentials are invalid or expired
      type: string
      enum:
        - missingCredentials
        - invalidCredentials
    Error403:
      description: >-
        Forbidden. This code indicates that the server understood the request
        but refuses to authorize it.
        (https://tools.ietf.org/html/rfc7231#section-6.5.3)
      allOf:
        - $ref: "#/components/schemas/Error"
        - type: object
          properties:
            code:
              description: |-
                This code indicates that the server understood
                the request but refuses to authorize it because
                of one of the following error codes:
                - accessDenied: Access denied
                - forbiddenRequester: Forbidden requester
                - tooManyUsers: Too many users
              $ref: "#/components/schemas/Error403Code"
          required:
            - code
    Error403Code:
      description: |-
        This code indicates that the server understood
        the request but refuses to authorize it because
        of one of the following error codes:
        - accessDenied: Access denied
        - forbiddenRequester: Forbidden requester
        - tooManyUsers: Too many users
      type: string
      enum:
        - accessDenied
        - forbiddenRequester
        - tooManyUsers
    Error404:
      description: >-
        Resource for the requested path not found.
        (https://tools.ietf.org/html/rfc7231#section-6.5.4)
      allOf:
        - $ref: "#/components/schemas/Error"
        - type: object
          properties:
            code:
              description: |
                The following error code:
                - notFound: A current representation for the target resource
                not found
              type: string
              enum:
                - notFound
          required:
            - code
    Error409:
      description: Conflict (https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.8)
      allOf:
        - $ref: "#/components/schemas/Error"
        - type: object
          properties:
            code:
              description: |
                The following error code:
                - conflict: The client has provided a value whose semantics are
                not appropriate for the property.
              type: string
              enum:
                - conflict
          required:
            - code
    Error422:
      description: >-
        Unprocessable entity due to a business validation problem.
        (https://tools.ietf.org/html/rfc4918#section-11.2)
      allOf:
        - $ref: "#/components/schemas/Error"
        - type: object
          properties:
            code:
              description: |
                One of the following error codes:
                  - missingProperty: The property the Seller has expected is not present in the payload
                  - invalidValue: The property has an incorrect value
                  - invalidFormat: The property value does not comply with the expected value format
                  - referenceNotFound: The object referenced by the property cannot be identified in the Seller system
                  - unexpectedProperty: Additional property, not expected by the Seller has been provided
                  - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.
                  - otherIssue: Other problem was identified (detailed information provided in a reason)
              $ref: "#/components/schemas/Error422Code"
            propertyPath:
              description: >
                A pointer to a particular property of the payload that caused
                the validation issue. It is highly recommended that this
                property should be used.

                Defined using JavaScript Object Notation (JSON) Pointer
                (https://tools.ietf.org/html/rfc6901).
              type: string
          required:
            - code
    Error422Code:
      description: |
        One of the following error codes:
          - missingProperty: The property the Seller has expected is not present in the payload
          - invalidValue: The property has an incorrect value
          - invalidFormat: The property value does not comply with the expected value format
          - referenceNotFound: The object referenced by the property cannot be identified in the Seller system
          - unexpectedProperty: Additional property, not expected by the Seller has been provided
          - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.
          - otherIssue: Other problem was identified (detailed information provided in a reason)
      type: string
      enum:
        - missingProperty
        - invalidValue
        - invalidFormat
        - referenceNotFound
        - unexpectedProperty
        - tooManyRecords
        - otherIssue
    Error500:
      description: >-
        Internal Server Error.
        (https://tools.ietf.org/html/rfc7231#section-6.6.1)
      allOf:
        - $ref: "#/components/schemas/Error"
        - type: object
          properties:
            code:
              description: |
                The following error code:
                - internalError: Internal server error - the server encountered
                an unexpected condition that prevented it from fulfilling the
                request.
              type: string
              enum:
                - internalError
          required:
            - code
    Error501:
      description: >-
        Not Implemented. Used in case Seller is not supporting an optional
        operation (https://tools.ietf.org/html/rfc7231#section-6.6.2)
      allOf:
        - $ref: "#/components/schemas/Error"
        - type: object
          properties:
            code:
              description: |-
                The following error code:
                - notImplemented: Method not supported by the server
              type: string
              enum:
                - notImplemented
          required:
            - code
    Event:
      description: >-
        Event class is used to describe information structure used for
        notification.
      type: object
      properties:
        eventId:
          description: Id of the event
          type: string
        eventTime:
          description: Date-time when the event occurred
          type: string
          format: date-time
        eventType:
          description: The type of the notification.
          type: string
        event:
          description: The event linked to the involved resource object
          type: object
      required:
        - event
        - eventId
        - eventTime
        - eventType
    PlannedOutageIndicator:
      description: >-
        Indicates that the Managed Object (related to this alarm) is in in
        planned maintenance, or out of service.
      type: string
      enum:
        - inPlannedMaintenance
        - outOfService
    PerceivedSeverity:
      description: >-
        List of possible severities that can be allocated to an Alarm. 

        The values are consistent with ITU - T Recommendation X.733. 

        Once an alarm has been cleared, its perceived severity is set to 

        'cleared' and can no longer be set



        | state           | Mplify 133.1 name    |
        Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
        |

        | --------------- | --------------- |
        ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
        |

        | `cleared`       | Cleared         |  The Cleared severity level
        indicates the clearing of one or more previously reported alarms. |

        | `critical`      | Critical        |  The Critical severity level
        indicates that a ser

# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mef/refs/heads/main/openapi/mef-lso-interlude-alarm-notification-openapi.yml
MEF LSO Interlude Alarm Notification

Documentation

Specifications

Other Resources

OpenAPI Specification
