MEF events subscription API

openapi: 3.2.0
info:
  title: Mef events subscription API
  version: '1.0'
  description: 'Operations tagged events subscription across 38 of this provider''s published API definitions: mef-lso-allegro-alarm-management-openapi.yml, mef-lso-allegro-fault-management-openapi.yml, mef-lso-allegro-performance-monitoring-openapi.yml, mef-lso-allegro-service-function-test-openapi.yml, mef-lso-allegro-service-inventory-management-openapi.yml, mef-lso-allegro-service-ordering-management-openapi.yml, mef-lso-cantata-appointment-management-openapi.yml, mef-lso-cantata-billing-management-openapi.yml, mef-lso-cantata-circuit-impairment-and-maintenance-openapi.yml, mef-lso-cantata-geographic-address-management-openapi.yml, mef-lso-cantata-product-catalog-openapi.yml, mef-lso-cantata-product-offering-qualification-management-openapi.yml, mef-lso-cantata-product-order-management-openapi.yml, mef-lso-cantata-quote-management-openapi.yml, mef-lso-cantata-trouble-ticket-management-openapi.yml, mef-lso-cantata-workorder-management-openapi.yml, mef-lso-interlude-alarm-management-openapi.yml, mef-lso-interlude-fault-management-openapi.yml, mef-lso-interlude-performance-monitoring-openapi.yml, mef-lso-interlude-service-function-test-openapi.yml, mef-lso-interlude-service-inventory-management-openapi.yml, mef-lso-interlude-service-ordering-management-openapi.yml, mef-lso-legato-alarm-management-openapi.yml, mef-lso-legato-fault-management-openapi.yml, mef-lso-legato-performance-monitoring-openapi.yml, mef-lso-legato-service-function-test-openapi.yml, mef-lso-legato-service-inventory-management-openapi.yml, mef-lso-legato-service-ordering-management-openapi.yml, mef-lso-sonata-appointment-management-openapi.yml, mef-lso-sonata-billing-management-openapi.yml, mef-lso-sonata-circuit-impairment-and-maintenance-openapi.yml, mef-lso-sonata-geographic-address-management-openapi.yml, mef-lso-sonata-product-catalog-openapi.yml, mef-lso-sonata-product-offering-qualification-management-openapi.yml, mef-lso-sonata-product-order-management-openapi.yml, mef-lso-sonata-quote-management-openapi.yml, mef-lso-sonata-trouble-ticket-management-openapi.yml, mef-lso-sonata-workorder-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{serverBase}/mefApi/allegro/alarmManagement/v3/
  variables:
    serverBase:
      description: The base of SOF's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/allegro/faultManagement/v3/
  variables:
    serverBase:
      default: mplify.com
      description: The base hostname of the SOF (Service Orchestration Function) server.
- url: https://{serverBase}/mefApi/allegro/performanceMonitoring/v5/
  variables:
    serverBase:
      default: mplify.com
      description: The base hostname of the SOF (Service Orchestration Function) server.
- url: https://{serverBase}/mefApi/allegro/serviceFunctionTesting/v3/
  variables:
    serverBase:
      description: The base of SOF's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/allegro/serviceInventory/v2/
  variables:
    serverBase:
      description: The base of SOF's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/allegro/serviceOrderingManagement/v1/
  variables:
    serverBase:
      description: The base of SOF's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/cantata/appointment/v3/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/cantata/customerBillManagement/v3/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/cantata/cimIncident/v1/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mef.net
- url: https://{serverBase}/mefApi/cantata/geographicAddressManagement/v2/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mplify.net
- url: http://{serverBase}/mefApi/cantata/productCatalog/v4/
  variables:
    serverBase:
      description: The base of Buyer's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/cantata/productOfferingQualification/v8/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/cantata/quoteManagement/v4/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/cantata/troubleTicket/v5/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/cantata/workOrderManagement/v3/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/interlude/alarmManagement/v3/
  variables:
    serverBase:
      description: The base of SOF's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/interlude/faultManagement/v3/
  variables:
    serverBase:
      default: mplify.com
      description: The base hostname of the SOF (Service Orchestration Function) server.
- url: https://{serverBase}/mefApi/interlude/performanceMonitoring/v5/
  variables:
    serverBase:
      default: mplify.com
      description: The base hostname of the SOF (Service Orchestration Function) server.
- url: https://{serverBase}/mefApi/interlude/serviceFunctionTesting/v3/
  variables:
    serverBase:
      description: The base of SOF's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/interlude/serviceInventory/v2/
  variables:
    serverBase:
      description: The base of SOF's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/interlude/serviceOrderingManagement/v1/
  variables:
    serverBase:
      description: The base of SOF's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/legato/alarmManagement/v3/
  variables:
    serverBase:
      description: The base of SOF's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/legato/faultManagement/v3/
  variables:
    serverBase:
      default: mplify.com
      description: The base hostname of the SOF (Service Orchestration Function) server.
- url: https://{serverBase}/mefApi/legato/performanceMonitoring/v5/
  variables:
    serverBase:
      default: mplify.com
      description: The base hostname of the SOF (Service Orchestration Function) server.
- url: https://{serverBase}/mefApi/legato/serviceFunctionTesting/v3/
  variables:
    serverBase:
      description: The base of SOF's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/legato/serviceInventory/v7/
  variables:
    serverBase:
      description: The base of SOF's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/legato/serviceOrderingManagement/v6/
  variables:
    serverBase:
      description: The base of SOF's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/sonata/appointment/v3/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/sonata/customerBillManagement/v3/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/sonata/cimIncident/v1/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mef.net
- url: https://{serverBase}/mefApi/sonata/geographicAddressManagement/v8/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mplify.net
- url: http://{serverBase}/mefApi/sonata/productCatalog/v4/
  variables:
    serverBase:
      description: The base of Buyer's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/sonata/productOfferingQualification/v8/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/sonata/productOrderingManagement/v11/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/sonata/quoteManagement/v10/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/sonata/troubleTicket/v5/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/sonata/workOrderManagement/v3/
  variables:
    serverBase:
      description: The base of Seller's URL.
      default: mplify.net
tags:
- name: events subscription
paths:
  /hub:
    post:
      tags:
      - events subscription
      summary: Register a listener
      description: The Buyer/Client or Administrator requests to subscribe to  Alarm Notifications.
      operationId: registerListener
      requestBody:
        description: Data containing the callback endpoint to deliver the information.
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/EventSubscriptionInput'
        required: true
      responses:
        '201':
          description: Subscribed
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/EventSubscription'
        '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'
        '501':
          description: Method not implemented.
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error501'
    servers:
    - url: https://{serverBase}/mefApi/allegro/alarmManagement/v3/
      variables:
        serverBase:
          description: The base of SOF's URL.
          default: mplify.net
  /hub/{id}:
    get:
      tags:
      - events subscription
      summary: Retrieves a Hub by ID.
      description: The Buyer/Client requests detailed information about  a single Notification Hub based on the Hub Identifier.
      operationId: retrieveHub
      parameters:
      - name: id
        in: path
        description: Identifier of the Hub
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/EventSubscription'
        '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'
        '404':
          description: Not Found
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error404'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
        '501':
          description: Method not implemented.
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error501'
    delete:
      tags:
      - events subscription
      summary: Unregister a listener
      description: The Buyer/Client or Administrator requests to unsubscribe from  Alarm Notifications.
      operationId: unregisterListener
      parameters:
      - name: id
        in: path
        description: The id of the registered listener
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Deleted
        '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'
        '404':
          description: Not Found
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error404'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
        '501':
          description: Method not implemented.
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error501'
    servers:
    - url: https://{serverBase}/mefApi/allegro/alarmManagement/v3/
      variables:
        serverBase:
          description: The base of SOF's URL.
          default: mplify.net
components:
  schemas:
    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
    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
    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
    EventSubscriptionInput:
      description: This class is used to register for Notifications.
      type: object
      properties:
        callback:
          description: 'This callback value must be set to *host* property from Alarm Notification API (alarmNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct an URL to which  notification is sent. E.g. for ''callback'':  "https://buyer.mplify.com/listenerEndpoint", the alarm event notification will be  sent to: `https://buyer.mplify.com/listenerEndpoint/mefApi/allegro/alarmNotification/v3/listener/`'
          type: string
        query:
          description: 'This attribute is used to define which type of events to register to. Example: ''query'':''eventType =  createAlarm''. To subscribe for more than one event type, put the values separated by a comma: `eventType=alarmCreateEvent, alarmAttributeValueChangeEvent`. The possible values are enumerated by Event type enums in alarmNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.'
          type: string
      required:
      - callback
    EventSubscription:
      required:
      - id
      allOf:
      - $ref: '#/components/schemas/EventSubscriptionInput'
      - description: This resource is used to respond to notification subscriptions.
        type: object
        properties:
          id:
            description: An identifier of this Event Subscription assigned when a resource is created.
            type: string
    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
    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
    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
    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
    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
    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
    Error400Code_2:
      type: string
      description: "One of the following error codes:\n- missingQueryParameter: The URI is missing a required query-string \n  parameter.\n- missingQueryValue: The URI is missing a required query-string \n  parameter value.\n- invalidQuery: The query section of the URI is invalid.\n- invalidBody: The request has an invalid body."
      enum:
      - missingQueryParameter
      - missingQueryValue
      - invalidQuery
      - invalidBody
    Error404_2:
      allOf:
      - $ref: '#/components/schemas/Error_2'
      - type: object
        properties:
          code:
            type: string
            description: "The following error code:\n- notFound: A current representation of the target resource \n  not found."
            enum:
            - notFound
        required:
        - code
      description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4)
    Error403_2:
      allOf:
      - $ref: '#/components/schemas/Error_2'
      - type: object
        properties:
          code:
            $ref: '#/components/schemas/Error403Code_2'
            description: Error code
        required:
        - code
      description: Forbidden. This code indicates that the server understood the request but refused to authorize it. (https://tools.ietf.org/html/rfc7231#section-6.5.3)
    EventSubscriptionInput_2:
      type: object
      description: This class is used to register for Notifications.
      properties:
        callback:
          type: string
          description: 'This callback value must be set to the *host* property from Fault Management Notification API (faultNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct a URL to which notification is sent. E.g. for ''callback'': "https://bus.mplify.com/listenerEndpoint", the Fault Management Job state change event notification will be sent to `https://bus.mplify.com/listenerEndpoint/mefApi/allegro/faultManagement/v3/listener/faultManagementJobStateChangeEvent`'
        query:
          type: string
          description: 'This attribute is used to define which type of events to register to. Example: ''query'':''eventType = faultManagementReportStateChangeEvent''. To subscribe for more than one event type, put the values separated by a comma: `eventType=faultManagementReportStateChangeEvent,faultManagementJobCreateEvent`. The possible values are enumerated by Event type enums in faultNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.'
      required:
      - callback
    EventSubscription_2:
      type: object
      description: This resource is used to respond to notification subscriptions.
      properties:
        callback:
          type: string
          description: The value provided by the `EventSubscriptionInput` during notification registration.
        id:
          type: string
          description: An identifier of this Event Subscription assigned when a resource is created.
        query:
          type: string
          description: The value provided by the `EventSubscriptionInput` during notification registration.
      required:
      - callback
      - id
    Error401_2:
      allOf:
      - $ref: '#/components/schemas/Error_2'
      - type: object
        properties:
          code:
            $ref: '#/components/schemas/Error401Code_2'
            description: Error code
        required:
        - code
      description: '''Unauthorized.  (https://tools.ietf.org/html/rfc7235#section-3.1)'''
    Error401Code_2:
      type: string
      description: 'One of the following error codes:

        - missingCredentials: No credentials provided.

        - invalidCredentials: Provided credentials are invalid or expired.'
      enum:
      - missingCredentials
      - invalidCredentials
    Error400_2:
      allOf:
      - $ref: '#/components/schemas/Error_2'
      - type: object
        properties:
          code:
            $ref: '#/components/schemas/Error400Code_2'
            description: Error code
        required:
        - code
      description: '''Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)'''
    Error501_2:
      allOf:
      - $ref: '#/components/schemas/Error_2'
      - type: object
        properties:
          code:
            type: string
            description: 'The following error code:

              - notImplemented: Method not supported by the server.'
            enum:
            - notImplemented
        required:
        - code
      description: Not Implemented. Used in case Seller is not supporting an optional operation. (https://tools.ietf.org/html/rfc7231#section-6.6.2)
    Error500_2:
      allOf:
      - $ref: '#/components/schemas/Error_2'
      - type: object
        properties:
          code:
            type: string
            description: 'The following error code: - 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)
    Error403Code_2:
      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
    Error_2:
      type: object
      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.
      properties:
        message:
          type: string
          description: Text that provides more details and corrective actions related to the error. This can be shown to a client user.
        reason:
          type: string
          description: Text that explains the reason for the error. This can be shown to a client user.
          maxLength: 255
        referenceError:
          type: string
          description: URL pointing to documentation describing the error.
          format: uri
      required:
      - reason
    Error400Code_3:
      type: string
      description: "One of the following error codes:\n- missingQueryParameter: The URI is missing a required query-string \n  parameter\n- missingQueryValue: The URI is missing a required query-string \n  parameter value\n- invalidQuery: The query section of the URI is invalid\n- invalidBody: The request has an invalid body."
      enum:
      - missingQueryParameter
      - missingQueryValue
      - invalidQuery
      - invalidBody
    Error404_3:
      allOf:
      - $ref: '#/components/schemas/Error_3'
      - type: object
        properties:
          code:
            type: string
            description: "The following error code:\n- notFound: A current representation of the target resource \n  not found."
            enum:
            - notFound
        required:
        - code
      description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4)
    Error403_3:
      allOf:
      - $ref: '#/components/schemas/Error_3'
      - type: object
        properties:
          code:
            $ref: '#/components/schemas/Error403Code_3'
        required:
        - code
      description: Forbidden. This code indicates that the server understood the request but refused to authorize it. (https://tools.ietf.org/html/rfc7231#section-6.5.3)
    EventSubscriptionInput_3:
      type: object
      description: This class is used to register for Notifications.
      properties:
        callback:
          type: string
          description: 'This callback value must be set to the *host* property from Performance Notification API (performanceNotification.api.yaml). This property is appended with the base path and notification resource path specified in that API to construct a URL to which notification is sent. E.g. for ''callback'': "https://bus.mplify.com/listenerEndpoint", the performance job state change event notification will be sent to `https://bus.mplify.com/listenerEndpoint/mefApi/allegro/performanceMonitoring/v5/listener/performanceJobStateChangeEvent`.'
        query:
          type: string
          description: 'This attribute is used to define which type of events to register to. Example: ''query'':''eventType = performanceReportStateChangeEvent''. To subscribe for more than one event type, put the values separated by a comma: `eventType=performanceReportStateChangeEvent,performanceJobCreateEvent`. The possible values are enumerated by Event type enums in performanceNotification.api.yaml. An empty query is treated as specifying no filters - ending in subscription for all event types.'
      required:
      - callback
    EventSubscription_3:
      type: object
      description: This resource is used to respond to notification subscriptions.
      properties:
        callback:
          type: string
          description: The value provided by the `EventSubscriptionInput` during notification registration.
        id:
          type: string
          description: An identifier of this Event Subscription assigned when a resource is created.
        query:
          type: string
          description: The value provided by the `EventSubscriptionInput` during notification registration.
      required:
      - callback
      - id
    Error401_3:
      allOf:
      - $ref: '#/components/schemas/Error_3'
      - type: object
        properties:
          code:
            $ref: '#/components/schemas/Error401Code_3'
        required:
        - code
      description: '''Unauthorized.  (https://tools.ietf.org/html/rfc7235#section-3.1)'''
    Error401Code_3:
      type: string
      description: 'One of the following error codes:

        - missingCredentials: No credentials provided

        - invalidCredentials: Provided credentials are invalid or expired.'
      enum:
      - missingCredentials
      - invalidCredentials
    Error400_3:
      allOf:
      - $ref: '#/components/schemas/Error_3'
      - type: object
        properties:
          code:
            $ref: '#/components/schemas/Error400Code_3'
        required:
        - code
      description: '''Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)'''
    Error501_3:
      allOf:
      - $ref: '#/components/schemas/Error_3'
      - type: object
        properties:
          code:
            type: string
            description: 'The following error code:

              - notImplemented: Method not supported by the server.'
            enum:
            - notImplemented
        required:
        - code
      description: Not Implemented. Used in case Seller is not supporting an optional operation. (https://tools.ietf.org/html/rfc7231#section-6.6.2)
    Error500_3:
      allOf:
      - $ref: '#/components/

# --- truncated at 32 KB (247 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mef/refs/heads/main/openapi/mef-events-subscription-api-openapi.yml