MEF LSO Allegro Fault Management

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


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


    Mplify Fault Management API allows to manage Fault Management Jobs, collect 
    Fault Management Reports, as well as receive notifications related to these
    entities. This provides the ability for the Buyer/Client to request that 
    the Seller/Server performs actions defined by FM Job, and to retrieve 
    the results of the Job. Examples of the Fault Management Job are Link Trace 
    and Loopback. 


    Two types of entities are supported by the API:
    - **Fault Management Job** - specifies the Fault Management Job
      configuration. FM Job is typically run as part of a troubleshooting or 
      diagnostic process of a service, an ordered pair (e.g., two UNIs), 
      or an entity (e.g., port). 


    - **Fault Management Report** - The execution of Fault Management Job 
      results in Fault Management Reports that provide Buyer/Client with the 
      job results.


    List of use cases supported by the API:
    - Create Fault Management Job
    - Retrieve list of Fault Management Jobs
    - Retrieve Fault Management Job by Identifier
    - Modify Fault Management Job
    - Retrieve list of Modify Fault Management Job
    - Retrieve Modify Fault Management Job by Identifier
    - Cancel Fault Management Job
    - Retrieve list of Cancel Fault Management Job
    - Retrieve Cancel Fault Management Job by Identifier
    - Suspend Fault Management Job
    - Resume Fault Management Job
    - Subscribe to Fault Management Job Notifications
    - Unsubscribe from Fault Management Job Notifications
    - Retrieve list of Fault Management Reports
    - Retrieve Fault Management Report by Identifier
    - Subscribe to Fault Management Report Notifications
    - Unsubscribe from Fault Management Report Notifications

    Copyright 2025 Mplify Alliance and its contributors

  title: Fault Management
  version: 3.0.0
servers:
  - url: 'https://{serverBase}/mefApi/allegro/faultManagement/v3/'
    variables:
      serverBase:
        default: mplify.com
        description:
          The base hostname of the SOF (Service Orchestration Function) server.
tags:
  - name: faultManagementJob
  - name: faultManagementReport
  - name: trackingRecord
  - name: events subscription
paths:
  /faultManagementJob:
    get:
      description: >-
        The Buyer/Client requests a list of FM Jobs based on a set of filter
        criteria. The Seller/Server returns a summarized list of FM  Jobs. For
        each FM Job returned, the Seller/Server also provides a  Fault
        Management Job Identifier that uniquely identifies this FM Job  within
        the Seller/Server. The order of the elements returned to the
        Buyer/Client is defined by the Seller/Server (e.g. natural order) and
        does not change between the pages.
      operationId: listFaultManagementJob
      parameters:
        - description: >-
            Identifier of a Service.
          explode: true
          in: query
          name: serviceId
          required: false
          schema:
            type: string
          style: form
        - description: >-
            Identifier of a Service From endpoint.
          explode: true
          in: query
          name: serviceFromId
          required: false
          schema:
            type: string
          style: form
        - description: >-
            Identifier of a Service To endpoint.
          explode: true
          in: query
          name: serviceToId
          required: false
          schema:
            type: string
          style: form
        - description: >-
            Identifier of an Entity.
          explode: true
          in: query
          name: entityId
          required: false
          schema:
            type: string
          style: form
        - description: >-
            State of the Fault Management Job. See
            `FaultManagementJobStateType` definition for details.
          explode: true
          in: query
          name: state
          required: false
          schema:
            $ref: '#/components/schemas/FaultManagementJobStateType'
          style: form
        - description: Date when the job was created - greater than.
          explode: true
          in: query
          name: creationDateTime.gt
          required: false
          schema:
            format: date-time
            type: string
          style: form
        - description: Date when the job was created - lower than.
          explode: true
          in: query
          name: creationDateTime.lt
          required: false
          schema:
            format: date-time
            type: string
          style: form
        - description: Type of the Fault Management Job.
          explode: true
          in: query
          name: jobType
          required: false
          schema:
            $ref: '#/components/schemas/JobType'
          style: form
        - description: The priority of the Fault Management Job.
          explode: true
          in: query
          name: jobPriority
          required: false
          schema:
            type: string
          style: form
        - description: >-
            Requested index for start of item to be provided in response
            requested by the client. Note that the index starts with "0".
          explode: true
          in: query
          name: offset
          required: false
          schema:
            type: integer
          style: form
        - description: >-
            Requested number of resources to be provided in response.
          explode: true
          in: query
          name: limit
          required: false
          schema:
            format: int32
            type: integer
          style: form
      responses:
        '200':
          content:
            application/json;charset=utf-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FaultManagementJob'
          description: >-
            'OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)'
          headers:
            X-Pagination-Throttled:
              description: >-
                Used to indicate that result page was throttled to maximum
                possible size and there are additional results that can be
                fetched.
              explode: false
              schema:
                type: boolean
              style: simple
            X-Total-Count:
              description: >-
                The total number of matching items. E.g. if there are 50
                matching items in total, but the request has offset=10 and
                limit=10, then the X-Total-Count is 50.
              explode: false
              schema:
                type: integer
              style: simple
            X-Result-Count:
              description: The number of items included in the response.
              explode: false
              schema:
                type: integer
              style: simple
        '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
        '422':
          content:
            application/json;charset=utf-8:
              schema:
                items:
                  $ref: '#/components/schemas/Error422'
                type: array
          description: >-
            Unprocessable entity due to the business validation problems.
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: List or find Fault Management Job objects.
      tags:
        - faultManagementJob
    post:
      description: >-
        A request initiated by the Buyer/Client to create a Fault Management
        Job in the Seller/Server system.
      operationId: createFaultManagementJob
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/FaultManagementJob_Create'
        description: The Fault Management Job to be created.
        required: true
      responses:
        '201':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/FaultManagementJob'
          description: >-
            'Created (https://tools.ietf.org/html/rfc7231#section-6.3.2)'
        '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
        '422':
          content:
            application/json;charset=utf-8:
              schema:
                items:
                  $ref: '#/components/schemas/Error422'
                type: array
          description: >-
            Unprocessable entity due to the business validation problems.
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Creates a Fault Management Job.
      tags:
        - faultManagementJob
  '/faultManagementJob/{id}':
    get:
      description: >-
        The Buyer/Client requests detailed information about a single Fault
        Management Job based on the Job Identifier.
      operationId: retrieveFaultManagementJob
      parameters:
        - description: Identifier of the Fault Management Job.
          explode: false
          in: path
          name: id
          required: true
          schema:
            type: string
          style: simple
      responses:
        '200':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/FaultManagementJob'
          description: >-
            'OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)'
        '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
        '404':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error404'
          description: Not Found
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Retrieves a Fault Management Job by ID.
      tags:
        - faultManagementJob
  '/faultManagementJob/{id}/resume':
    post:
      description: >-
        A request initiated by the Buyer/Client to resume a Fault Management
        Job.
      operationId: resumeFaultManagementJob
      parameters:
        - description: Identifier of the FaultManagementJob.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Resumed
        '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
        '404':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error404'
          description: Not Found
        '422':
          content:
            application/json;charset=utf-8:
              schema:
                items:
                  $ref: '#/components/schemas/Error422'
                type: array
          description:
            Unprocessable entity due to the business validation problems.
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Resumes a Fault Management Job
      tags:
        - faultManagementJob
  '/faultManagementJob/{id}/suspend':
    post:
      description: >-
        A request initiated by the Buyer/Client to suspend a Fault Management
        Job.
      operationId: suspendFaultManagementJob
      parameters:
        - description: Identifier of the FaultManagementJob.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Suspended
        '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
        '404':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error404'
          description: Not Found
        '422':
          content:
            application/json;charset=utf-8:
              schema:
                items:
                  $ref: '#/components/schemas/Error422'
                type: array
          description:
            Unprocessable entity due to the business validation problems.
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Suspends a Fault Management Job.
      tags:
        - faultManagementJob
  /cancelFaultManagementJob:
    get:
      description: >-
        The Buyer/Client requests a list of Cancel Fault Management Job based
        on a set of filter criteria.
      operationId: listCancelFaultManagementJob
      parameters:
        - description: >-
            Identifier of Fault Management Job that is a subject of
            CancelFaultManagementJob.
          explode: true
          in: query
          name: faultManagementJobId
          required: false
          schema:
            type: string
          style: form
        - description: >-
            State of CancelFaultManagementJob. See
            `FaultManagementJobProcessStateType` definition for details.
          explode: true
          in: query
          name: state
          required: false
          schema:
            $ref: '#/components/schemas/FaultManagementJobProcessStateType'
          style: form
        - description: >-
            Date when the CancelFaultManagementJob was created - greater than.
          explode: true
          in: query
          name: creationDateTime.gt
          required: false
          schema:
            format: date-time
            type: string
          style: form
        - description: >-
            Date when the CancelFaultManagementJob was created - lower than.
          explode: true
          in: query
          name: creationDateTime.lt
          required: false
          schema:
            format: date-time
            type: string
          style: form
        - description: >-
            Requested index for start of item to be provided in response
            requested by client. Note that the index starts with "0".
          explode: true
          in: query
          name: offset
          required: false
          schema:
            type: integer
            format: int32
          style: form
        - description: >-
            Requested number of items to be provided in response requested by
            client.
          explode: true
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
          style: form
      responses:
        '200':
          content:
            application/json;charset=utf-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CancelFaultManagementJob'
          description: Success
          headers:
            X-Pagination-Throttled:
              description: >-
                Used to indicate that result page was throttled to maximum
                possible size and there are additional results that can be
                fetched.
              explode: false
              schema:
                type: boolean
              style: simple
            X-Total-Count:
              description: >-
                The total number of matching items. E.g. if there are 50
                matching items in total, but the request has offset=10 and
                limit=10, then the X-Total-Count is 50.
              explode: false
              schema:
                type: integer
              style: simple
            X-Result-Count:
              description: The number of items included in the response.
              explode: false
              schema:
                type: integer
              style: simple
        '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
        '422':
          content:
            application/json;charset=utf-8:
              schema:
                items:
                  $ref: '#/components/schemas/Error422'
                type: array
          description: >-
            Unprocessable entity due to the business validation problems.
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: List or find CancelFaultManagementJob objects.
      tags:
        - faultManagementJob
    post:
      description: >-
        A request initiated by the Buyer/Client to cancel  a Fault Management
        Job in the Seller/Server system.
      operationId: createCancelFaultManagementJob
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/CancelFaultManagementJob_Create'
        description: The CancelFaultManagementJob to be created.
        required: true
      responses:
        '201':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/CancelFaultManagementJob'
          description: Created
        '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
        '422':
          content:
            application/json;charset=utf-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Error422'
          description: >-
            Unprocessable entity due to the business validation problems.
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Creates a Cancel Fault Management Job entity.
      tags:
        - faultManagementJob
  /cancelFaultManagementJob/{id}:
    get:
      description: >-
        The Buyer/Client requests detailed information about a single Cancel
        Fault Management Job based on the Cancel Fault Management Job
        Identifier.
      operationId: retrieveCancelFaultManagementJob
      parameters:
        - description: Identifier of the CancelFaultManagementJob.
          explode: false
          in: path
          name: id
          required: true
          schema:
            type: string
          style: simple
      responses:
        '200':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/CancelFaultManagementJob'
          description: Success
        '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
        '404':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error404'
          description: Not Found
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Retrieves a CancelFaultManagementJob by ID.
      tags:
        - faultManagementJob
  /modifyFaultManagementJob:
    get:
      description: >-
        The Buyer/Client requests a list of Modify Fault Management Job based
        on a set of filter criteria.
      operationId: listModifyFaultManagementJob
      parameters:
        - description: >-
            Identifier of Fault Management Job that is a subject of
            ModifyFaultManagementJob.
          explode: true
          in: query
          name: faultManagementJobId
          required: false
          schema:
            type: string
          style: form
        - description: >-
            State of ModifyFaultManagementJob See
            `FaultManagementJobProcessStateType` definition for details.
          explode: true
          in: query
          name: state
          required: false
          schema:
            $ref: '#/components/schemas/FaultManagementJobProcessStateType'
          style: form
        - description: >-
            Date when the ModifyFaultManagementJob was created - greater than.
          explode: true
          in: query
          name: creationDateTime.gt
          required: false
          schema:
            format: date-time
            type: string
          style: form
        - description: >-
            Date when the ModifyFaultManagementJob was created - lower than.
          explode: true
          in: query
          name: creationDateTime.lt
          required: false
          schema:
            format: date-time
            type: string
          style: form
        - description: >-
            Requested index for start of item to be provided in response
            requested by client. Note that the index starts with "0".
          explode: true
          in: query
          name: offset
          required: false
          schema:
            type: integer
            format: int32
          style: form
        - description: >-
            Requested number of items to be provided in response requested by
            client.
          explode: true
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
          style: form
      responses:
        '200':
          content:
            application/json;charset=utf-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ModifyFaultManagementJob'
          description: Success
          headers:
            X-Pagination-Throttled:
              description: >-
                Used to indicate that result page was throttled to maximum
                possible size and there are additional results that can be
                fetched.
              explode: false
              schema:
                type: boolean
              style: simple
            X-Total-Count:
              description: >-
                The total number of matching items. E.g. if there are 50
                matching items in total, but the request has offset=10 and
                limit=10, then the X-Total-Count is 50.
              explode: false
              schema:
                type: integer
              style: simple
            X-Result-Count:
              description: The number of items included in the response.
              explode: false
              schema:
                type: integer
              style: simple
        '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
        '422':
          content:
            application/json;charset=utf-8:
              schema:
                items:
                  $ref: '#/components/schemas/Error422'
                type: array
          description: >-
            Unprocessable entity due to the business validation problems
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: List or find ModifyFaultManagementJob objects.
      tags:
        - faultManagementJob
    post:
      description: >-
        A request initiated by the Buyer/Client to modify a Fault Management
        Job in the Seller/Server system.
      operationId: createModifyFaultManagementJob
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/ModifyFaultManagementJob_Create'
        description: The ModifyFaultManagementJob to be created.
        required: true
      responses:
        '201':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/ModifyFaultManagementJob'
          description: Created
        '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
        '422':
          content:
            application/json;charset=utf-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Error422'
          description: >-
            Unprocessable entity due to the business validation problems.
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Creates a Modify Fault Management Job entity.
      tags:
        - faultManagementJob
  /modifyFaultManagementJob/{id}:
    get:
      description: >-
        The Buyer/Client requests detailed information about a single Modify
        Fault Management Job based on the Modify Fault Management Job
        Identifier.
      operationId: retrieveModifyFaultManagementJob
      parameters:
        - description: Identifier of the ModifyFaultManagementJob.
          explode: false
          in: path
          name: id
          required: true
          schema:
            type: string
          style: simple
      responses:
        '200':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/ModifyFaultManagementJob'
          description: Success
        '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
        '404':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error404'
          description: Not Found
        '500':
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
          description: Internal Server Error
      summary: Retrieves a ModifyFaultManagementJob by ID.
      tags:
        - faultManagementJob
  /faultManagementJobComplexQuery:
    post:
      description: >-
        A request initiated by the Buyer/Client to execute a Fault Management
        Job Complex Query in the Seller/Server system.
      operationId: faultManagementJobComplexQuery
      requestBody:
        content:
          application/json;charset=utf-8:
            schema:
              $ref: '#/components/schemas/FaultManagementJobComplexQuery_Create'
        description: The FaultManagementJobComplexQuery to be executed.
        required: true
      responses:
        '200':
          content:
            application/json;charset=utf-8:
              schema:
                type: array
                items:
        

# --- truncated at 32 KB (115 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mef/refs/heads/main/openapi/mef-lso-allegro-fault-management-openapi.yml