Siemens Building Operations API — Alarms

naftiko: 1.0.0-alpha2
info:
  label: Siemens Building Operations API — Alarms
  description: 'Siemens Building Operations API — Alarms. 2 operations. Lead operation: List Building Alarms. Self-contained
    Naftiko capability covering one Siemens business surface.'
  tags:
  - Siemens
  - Alarms
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SIEMENS_API_KEY: SIEMENS_API_KEY
capability:
  consumes:
  - type: http
    namespace: building-operations-alarms
    baseUri: https://buildingx.siemens.com/api/v1
    description: Siemens Building Operations API — Alarms business capability. Self-contained, no shared references.
    resources:
    - name: alarms
      path: /alarms
      operations:
      - name: listalarms
        method: GET
        description: List Building Alarms
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          description: Filter alarms by status
        - name: severity
          in: query
          type: string
          description: Filter alarms by severity level
        - name: from
          in: query
          type: string
          description: Return alarms from this timestamp
        - name: skip
          in: query
          type: integer
        - name: top
          in: query
          type: integer
    - name: alarms-alarmId-acknowledge
      path: /alarms/{alarmId}/acknowledge
      operations:
      - name: acknowledgealarm
        method: POST
        description: Acknowledge Building Alarm
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.SIEMENS_API_KEY}}'
  exposes:
  - type: rest
    namespace: building-operations-alarms-rest
    port: 8080
    description: REST adapter for Siemens Building Operations API — Alarms. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/alarms
      name: alarms
      description: REST surface for alarms.
      operations:
      - method: GET
        name: listalarms
        description: List Building Alarms
        call: building-operations-alarms.listalarms
        with:
          status: rest.status
          severity: rest.severity
          from: rest.from
          skip: rest.skip
          top: rest.top
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/alarms/{alarmid}/acknowledge
      name: alarms-alarmid-acknowledge
      description: REST surface for alarms-alarmId-acknowledge.
      operations:
      - method: POST
        name: acknowledgealarm
        description: Acknowledge Building Alarm
        call: building-operations-alarms.acknowledgealarm
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: building-operations-alarms-mcp
    port: 9090
    transport: http
    description: MCP adapter for Siemens Building Operations API — Alarms. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-building-alarms
      description: List Building Alarms
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: building-operations-alarms.listalarms
      with:
        status: tools.status
        severity: tools.severity
        from: tools.from
        skip: tools.skip
        top: tools.top
      outputParameters:
      - type: object
        mapping: $.
    - name: acknowledge-building-alarm
      description: Acknowledge Building Alarm
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: building-operations-alarms.acknowledgealarm
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.