Nokia NetAct Network Management Northbound Interface API — Fault Management

naftiko: 1.0.0-alpha2
info:
  label: Nokia NetAct Network Management Northbound Interface API — Fault Management
  description: 'Nokia NetAct Network Management Northbound Interface API — Fault Management. 3 operations. Lead operation:
    List active alarms. Self-contained Naftiko capability covering one Nokia Netact business surface.'
  tags:
  - Nokia Netact
  - Fault Management
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NOKIA_NETACT_API_KEY: NOKIA_NETACT_API_KEY
capability:
  consumes:
  - type: http
    namespace: nbi-fault-management
    baseUri: https://{netact-host}/api/v1
    description: Nokia NetAct Network Management Northbound Interface API — Fault Management business capability. Self-contained,
      no shared references.
    resources:
    - name: faults-alarms
      path: /faults/alarms
      operations:
      - name: listactivealarms
        method: GET
        description: List active alarms
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: severity
          in: query
          type: string
        - name: neDn
          in: query
          type: string
          description: Distinguished Name of the source NE
        - name: alarmType
          in: query
          type: string
        - name: fromTime
          in: query
          type: string
        - name: limit
          in: query
          type: integer
    - name: faults-alarms-alarmId
      path: /faults/alarms/{alarmId}
      operations:
      - name: getalarm
        method: GET
        description: Get alarm details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: alarmId
          in: path
          type: string
          required: true
    - name: faults-alarms-alarmId-acknowledge
      path: /faults/alarms/{alarmId}/acknowledge
      operations:
      - name: acknowledgealarm
        method: POST
        description: Acknowledge an alarm
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: alarmId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.NOKIA_NETACT_API_KEY}}'
  exposes:
  - type: rest
    namespace: nbi-fault-management-rest
    port: 8080
    description: REST adapter for Nokia NetAct Network Management Northbound Interface API — Fault Management. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/faults/alarms
      name: faults-alarms
      description: REST surface for faults-alarms.
      operations:
      - method: GET
        name: listactivealarms
        description: List active alarms
        call: nbi-fault-management.listactivealarms
        with:
          severity: rest.severity
          neDn: rest.neDn
          alarmType: rest.alarmType
          fromTime: rest.fromTime
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/faults/alarms/{alarmid}
      name: faults-alarms-alarmid
      description: REST surface for faults-alarms-alarmId.
      operations:
      - method: GET
        name: getalarm
        description: Get alarm details
        call: nbi-fault-management.getalarm
        with:
          alarmId: rest.alarmId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/faults/alarms/{alarmid}/acknowledge
      name: faults-alarms-alarmid-acknowledge
      description: REST surface for faults-alarms-alarmId-acknowledge.
      operations:
      - method: POST
        name: acknowledgealarm
        description: Acknowledge an alarm
        call: nbi-fault-management.acknowledgealarm
        with:
          alarmId: rest.alarmId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: nbi-fault-management-mcp
    port: 9090
    transport: http
    description: MCP adapter for Nokia NetAct Network Management Northbound Interface API — Fault Management. One tool per
      consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: list-active-alarms
      description: List active alarms
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nbi-fault-management.listactivealarms
      with:
        severity: tools.severity
        neDn: tools.neDn
        alarmType: tools.alarmType
        fromTime: tools.fromTime
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: get-alarm-details
      description: Get alarm details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: nbi-fault-management.getalarm
      with:
        alarmId: tools.alarmId
      outputParameters:
      - type: object
        mapping: $.
    - name: acknowledge-alarm
      description: Acknowledge an alarm
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: nbi-fault-management.acknowledgealarm
      with:
        alarmId: tools.alarmId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.