MEF
MEF LSO Allegro Performance Monitoring Notification

Performance Monitoring Notification — the OpenAPI definition published by Mplify (formerly MEF) in the MEF LSO Allegro SDK, Kylie release. LSO Allegro is the Interface Reference Point between a Customer and a Service Provider, covering the operational/service layer. 12 path(s), 12 operation(s). Apache-2.0 licensed and openly downloadable from public GitHub.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.1
info:
  description: |
    **This file forms part of Mplify 143**

    **This API implements part of Business Requirements & Use Cases described 
    in Mplify 133.1.**

    Performance Monitoring allows the Buyer/Client to provision entities that
    define performance objectives (Performance Profile, Performance Job),
    collect monitoring data (Performance Report), as well as receive
    notifications about these objects. This allows managing issues and 
    situations that are not part of normal operations of the Service provided 
    by the Seller.

    List of supported use cases:
    - Send Event Notification

    Copyright 2025 Mplify Alliance and its contributors

    This file includes content based on the TM Forum Performance Management API 
    (TMF628 v14.5.1) available at https://www.tmforum.org/resources/standard/tmf628-performance-management-api-rest-specification-r14-5-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.
  title: Performance Monitoring Notification
  version: 5.0.0
servers:
  - url: 'https://{serverBase}/mefApi/allegro/performanceNotification/v5/'
    variables:
      serverBase:
        default: mplify.net
        description: The base of Buyer/Client's URL.
tags:
  - description: >-
      The Buyer/Client's endpoint to send particular event types notifications
      to.
    name: Notification listeners
paths:
  /listener/performanceJobCreateEvent:
    post:
      description: >-
        Client listener for receiving the performanceJobCreateEvent
        notification.
      operationId: performanceJobCreateEvent
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/PerformanceJobCreateEvent'
        description: The event data
        required: true
      responses:
        '204':
          description:
            'No Content (https://tools.ietf.org/html/rfc7231#section-6.3.5)'
        '400':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
          description: Bad Request
        '401':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
          description: Unauthorized
        '403':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
          description: Forbidden
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Performance Job Create Notification endpoint.
      tags:
        - Notification listeners
  /listener/performanceJobStateChangeEvent:
    post:
      description: >-
        Client listener for receiving the performanceJobStateChangeEvent
        notification.
      operationId: performanceJobStateChangeEvent
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/PerformanceJobStateChangeEvent'
        description: The event data
        required: true
      responses:
        '204':
          description:
            'No Content (https://tools.ietf.org/html/rfc7231#section-6.3.5)'
        '400':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
          description: Bad Request
        '401':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
          description: Unauthorized
        '403':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
          description: Forbidden
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Performance Job State Change Notification endpoint.
      tags:
        - Notification listeners
  /listener/performanceJobAttributeValueChangeEvent:
    post:
      description: >-
        Client listener for receiving the
        performanceJobAttributeValueChangeEvent  notification.
      operationId: performanceJobAttributeValueChangeEvent
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/PerformanceJobAttributeValueChangeEvent'
        description: The event data
        required: true
      responses:
        '204':
          description:
            'No Content (https://tools.ietf.org/html/rfc7231#section-6.3.5)'
        '400':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
          description: Bad Request
        '401':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
          description: Unauthorized
        '403':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
          description: Forbidden
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Performance Job Attribute Value Change Notification endpoint.
      tags:
        - Notification listeners
  /listener/performanceJobReportReadyEvent:
    post:
      description: >-
        Client listener for receiving the performanceJobReportReadyEvent
        notification.
      operationId: performanceJobReportReadyEvent
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/PerformanceJobReportReadyEvent'
        description: The event data
        required: true
      responses:
        '204':
          description:
            'No Content (https://tools.ietf.org/html/rfc7231#section-6.3.5)'
        '400':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
          description: Bad Request
        '401':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
          description: Unauthorized
        '403':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
          description: Forbidden
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Performance Job Report Ready Notification endpoint.
      tags:
        - Notification listeners
  /listener/performanceJobReportPreparationErrorEvent:
    post:
      description: >-
        Client listener for receiving the
        performanceJobReportPreparationErrorEvent notification.
      operationId: performanceJobReportPreparationErrorEvent
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/PerformanceJobReportPreparationErrorEvent'
        description: The event data
        required: true
      responses:
        '204':
          description:
            'No Content (https://tools.ietf.org/html/rfc7231#section-6.3.5)'
        '400':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
          description: Bad Request
        '401':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
          description: Unauthorized
        '403':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
          description: Forbidden
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Performance Job Report Preparation Error Notification endpoint.
      tags:
        - Notification listeners
  /listener/cancelPerformanceJobStateChangeEvent:
    post:
      description: >-
        Client listener for receiving the cancelPerformanceJobStateChangeEvent
        notification.
      operationId: cancelPerformanceJobStateChangeEvent
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/CancelPerformanceJobStateChangeEvent'
        description: The event data
        required: true
      responses:
        '204':
          description:
            'No Content (https://tools.ietf.org/html/rfc7231#section-6.3.5)'
        '400':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
          description: Bad Request
        '401':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
          description: Unauthorized
        '403':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
          description: Forbidden
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Cancel Performance Job State Change Notification endpoint.
      tags:
        - Notification listeners
  /listener/modifyPerformanceJobStateChangeEvent:
    post:
      description: >-
        Client listener for receiving the modifyPerformanceJobStateChangeEvent
        notification.
      operationId: modifyPerformanceJobStateChangeEvent
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/ModifyPerformanceJobStateChangeEvent'
        description: The event data
        required: true
      responses:
        '204':
          description:
            'No Content (https://tools.ietf.org/html/rfc7231#section-6.3.5)'
        '400':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
          description: Bad Request
        '401':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
          description: Unauthorized
        '403':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
          description: Forbidden
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Modify Performance Job State Change Notification endpoint.
      tags:
        - Notification listeners
  /listener/performanceProfileCreateEvent:
    post:
      description: >-
        Client listener for receiving the performanceProfileCreateEvent
        notification.
      operationId: performanceProfileCreateEvent
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/PerformanceProfileCreateEvent'
        description: The event data
        required: true
      responses:
        '204':
          description:
            'No Content (https://tools.ietf.org/html/rfc7231#section-6.3.5)'
        '400':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
          description: Bad Request
        '401':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
          description: Unauthorized
        '403':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
          description: Forbidden
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Performance Profile Create Notification endpoint.
      tags:
        - Notification listeners
  /listener/performanceProfileAttributeValueChangeEvent:
    post:
      description: >-
        Client listener for receiving the
        performanceProfileAttributeValueChangeEvent notification.
      operationId: performanceProfileAttributeValueChangeEvent
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/PerformanceProfileAttributeValueChangeEvent'
        description: The event data
        required: true
      responses:
        '204':
          description:
            'No Content (https://tools.ietf.org/html/rfc7231#section-6.3.5)'
        '400':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
          description: Bad Request
        '401':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
          description: Unauthorized
        '403':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
          description: Forbidden
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary:
        Performance Profile Attribute Value Change Notification endpoint.
      tags:
        - Notification listeners
  /listener/performanceProfileDeleteEvent:
    post:
      description: >-
        Client listener for receiving the performanceProfileDeleteEvent
        notification.
      operationId: performanceProfileDeleteEvent
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/PerformanceProfileDeleteEvent'
        description: The event data
        required: true
      responses:
        '204':
          description:
            'No Content (https://tools.ietf.org/html/rfc7231#section-6.3.5)'
        '400':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
          description: Bad Request
        '401':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
          description: Unauthorized
        '403':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
          description: Forbidden
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Performance Profile Delete Notification endpoint.
      tags:
        - Notification listeners
  /listener/performanceReportCreateEvent:
    post:
      description: >-
        Client listener for receiving the performanceReportCreateEvent
        notification.
      operationId: performanceReportCreateEvent
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/PerformanceReportCreateEvent'
        description: The event data
        required: true
      responses:
        '204':
          description:
            'No Content (https://tools.ietf.org/html/rfc7231#section-6.3.5)'
        '400':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
          description: Bad Request
        '401':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
          description: Unauthorized
        '403':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
          description: Forbidden
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Performance Report Create Notification endpoint.
      tags:
        - Notification listeners
  /listener/performanceReportStateChangeEvent:
    post:
      description: >-
        Client listener for receiving the performanceReportStateChangeEvent
        notification.
      operationId: performanceReportStateChangeEvent
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/PerformanceReportStateChangeEvent'
        description: The event data
        required: true
      responses:
        '204':
          description:
            'No Content (https://tools.ietf.org/html/rfc7231#section-6.3.5)'
        '400':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
          description: Bad Request
        '401':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
          description: Unauthorized
        '403':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
          description: Forbidden
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Performance Report State Change Notification endpoint.
      tags:
        - Notification listeners
components:
  schemas:
    CancelPerformanceJobStateChangeEvent:
      allOf:
        - $ref: '#/components/schemas/Event'
        - type: object
          description: CancelPerformanceJobStateChangeEvent structure
          properties:
            eventType:
              description:
                Indicates the type of Cancel Performance Monitoring Job event.
              type: string
              enum:
                - cancelPerformanceJobStateChangeEvent
            event:
              description: |
                A reference to the Cancel Performance Monitoring Job that is source 
                of the notification.
              $ref: '#/components/schemas/CancelPerformanceJobStateChangeEventPayload'
          required:
            - event
            - eventType
    CancelPerformanceJobStateChangeEventPayload:
      type: object
      description: |-
        A reference to the Cancel Performance Monitoring Job that is source
        of the notification.
      properties:
        href:
          type: string
          description:
            Hyperlink to access the Cancel Performance Monitoring Job.
        id:
          type: string
          description: ID of the Cancel Performance Monitoring Job.
        state:
          $ref: '#/components/schemas/PerformanceJobProcessStateType'
          description: |-
            The state of the Cancel Performance Monitoring Job.
      required:
        - id
        - state
    Error:
      type: object
      description: >
        Standard Class used to describe API response error.

        Not intended to be use directly. The `code` in the HTTP header is used
        as a discriminator for the type of error returned in runtime.
      properties:
        reason:
          type: string
          description: >-
            Text that explains the reason for error. This can be shown to a
            client user.
          maxLength: 255
        message:
          type: string
          description: >-
            Text that provide mode details and corrective actions related to
            the error. This can be shown to a client user.
        referenceError:
          type: string
          description: url pointing to documentation describing the error.
          format: uri
      required:
        - reason
    Error400:
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              $ref: '#/components/schemas/Error400Code'
              description: Error code
          required:
            - code
      description:
        'Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)'
    Error400Code:
      type: string
      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.
      enum:
        - missingQueryParameter
        - missingQueryValue
        - invalidQuery
        - invalidBody
    Error401:
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              $ref: '#/components/schemas/Error401Code'
              description: Error code
          required:
            - code
      description:
        'Unauthorized.  (https://tools.ietf.org/html/rfc7235#section-3.1)'
    Error401Code:
      type: string
      description: |-
        One of the following error codes:
        - missingCredentials: No credentials provided.
        - invalidCredentials: Provided credentials are invalid or expired.
      enum:
        - missingCredentials
        - invalidCredentials
    Error403:
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              $ref: '#/components/schemas/Error403Code'
              description: Error code
          required:
            - code
      description:
        'Forbidden. (https://tools.ietf.org/html/rfc7231#section-6.5.3)'
    Error403Code:
      type: string
      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.
      enum:
        - accessDenied
        - forbiddenRequester
        - tooManyUsers
    Error500:
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              description: >-
                One of the following error codes: - internalError: Internal
                server error - the server encountered an unexpected condition
                that prevented it from fulfilling the request.
              enum:
                - internalError
          required:
            - code
      description: >-
        Internal Server Error.
        (https://tools.ietf.org/html/rfc7231#section-6.6.1)
    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
    ModifyPerformanceJobStateChangeEvent:
      allOf:
        - $ref: '#/components/schemas/Event'
        - description: ModifyPerformanceJobStateChangeEvent structure
          type: object
          properties:
            eventType:
              description:
                Indicates the type of Modify Performance Monitoring Job event.
              type: string
              enum:
                - modifyPerformanceJobStateChangeEvent
            event:
              description: |
                A reference to the Modify Performance Monitoring Job that is source 
                of the notification.
              $ref: '#/components/schemas/ModifyPerformanceJobStateChangeEventPayload'
          required:
            - event
            - eventType
    ModifyPerformanceJobStateChangeEventPayload:
      type: object
      description: |-
        A reference to the Modify Performance Monitoring Job that is source
        of the notification.
      properties:
        href:
          type: string
          description:
            Hyperlink to access the Modify Performance Monitoring Job.
        id:
          type: string
          description: ID of the Modify Performance Monitoring Job.
        state:
          $ref: '#/components/schemas/PerformanceJobProcessStateType'
          description: |-
            The state of the Modify Performance Monitoring Job.
      required:
        - id
        - state
    PerformanceJobAttributeValueChangeEvent:
      allOf:
        - $ref: '#/components/schemas/Event'
        - type: object
          description: PerformanceJobAttributeValueChangeEvent structure
          properties:
            eventType:
              description:
                Indicates the type of Performance Monitoring Job event.
              type: string
              enum:
                - performanceJobAttributeValueChangeEvent
            event:
              description: |
                A reference to the Performance Monitoring Job that is source
                of the notification.
              $ref: '#/components/schemas/PerformanceJobEventPayload'
          required:
            - event
            - eventType
    PerformanceJobCreateEvent:
      allOf:
        - $ref: '#/components/schemas/Event'
        - type: object
          description: PerformanceJobCreateEvent structure
          properties:
            eventType:
              description:
                Indicates the type of Performance Monitoring Job event.
              type: string
              enum:
                - performanceJobCreateEvent
            event:
              description: |
                A reference to the Performance Monitoring Job that is source
                of the notification.
              $ref: '#/components/schemas/PerformanceJobEventPayload'
          required:
            - event
            - eventType
    PerformanceJobEventPayload:
      type: object
      description: >-
        A reference to the Performance Monitoring Job that is source of the
        notification.
      properties:
        href:
          type: string
          description: Hyperlink to access the Performance Job.
        id:
          type: string
          description: ID of the Performance Job.
      required:
        - id
    PerformanceJobProcessStateType:
      type: string
      description: |-
        The state of the process related to the Performance Job.

        | state          | Mplify 133 name | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
        | -------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
        | `acknowledged` | Acknowledged    | The Cancel/Modify Performance Monitoring Job request has been received by the Seller/Server and has passed basic validation. Performance Monitoring Job Process Identifier is assigned in the Acknowledged state. The request remains Acknowledged until all validations as applicable are completed. If the attributes are validated, the request moves to the In-Progress state. If not all attributes are validated, the request moves to the Rejected state. |
        | `completed`    | Completed       | The Cancel/Modify Performance Monitoring Job request has been completed by the Seller/Server.                                                                                                                                                                                                                                                                                                                                                                    |
        | `inProgress`   | In-Progress     | The Cancel/Modify Performance Monitoring Job request has been validated and accepted by the Seller/Server and is in-progress.                                                                                                                                                                                                                                                                                                                                    |
        | `rejected`     | Rejected        | The Cancel/Modify Performance Monitoring Job request has failed validation and has been declined by the Seller/Server.                                                                                                                                                                                                                                                                                                                                           |
      enum:
        - acknowledged
        - completed
        - inProgress
        - rejected
    PerformanceJobReportPreparationErrorEvent:
      allOf:
        - $ref: '#/components/schemas/Event'
        - description: PerformanceJobReportPreparationErrorEvent structure
          type: object
          properties:
            eventType:
              description:
                Indicates the type of Performance Monitoring Job event.
              type: string
              enum:
                - performanceJobReportPreparationErrorEvent
            event:
              description: |
                A reference to the Performance Monitoring Job that is source 
                of the notification.
              $ref: '#/components/schemas/PerformanceJobReportPreparationErrorEventPayload'
          required:
            - event
            - eventType
    PerformanceJobReportPreparationErrorEventPayload:
      type: object
      description: >-
        A reference to the Performance Monitoring Job that is source of the
        notification.
      properties:
        href:
          type: string
          description: Hyperlink to access the Performance Job.
        id:
          type: string
          descr

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mef/refs/heads/main/openapi/mef-lso-allegro-performance-notification-openapi.yml
MEF LSO Allegro Performance Monitoring Notification

Documentation

Specifications

Other Resources

OpenAPI Specification
