Cisco Voice Portal Reporting API — Report Templates

naftiko: 1.0.0-alpha2
info:
  label: Cisco Voice Portal Reporting API — Report Templates
  description: 'Cisco Voice Portal Reporting API — Report Templates. 3 operations. Lead operation: Cisco Voice Portal List
    Available Report Templates. Self-contained Naftiko capability covering one Cisco Voice Portal business surface.'
  tags:
  - Cisco Voice Portal
  - Report Templates
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CISCO_VOICE_PORTAL_API_KEY: CISCO_VOICE_PORTAL_API_KEY
capability:
  consumes:
  - type: http
    namespace: reporting-report-templates
    baseUri: https://{reporting-server}:8111/cvp-reporting/rest
    description: Cisco Voice Portal Reporting API — Report Templates business capability. Self-contained, no shared references.
    resources:
    - name: report
      path: /report
      operations:
      - name: listreporttemplates
        method: GET
        description: Cisco Voice Portal List Available Report Templates
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: report-reportId-result
      path: /report/{reportId}/result
      operations:
      - name: getreportresult
        method: GET
        description: Cisco Voice Portal Get Report Execution Result
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: reportId
          in: path
          type: string
          required: true
        - name: format
          in: query
          type: string
          description: Output format
    - name: report-templateId-execute
      path: /report/{templateId}/execute
      operations:
      - name: executereport
        method: POST
        description: Cisco Voice Portal Execute a Report Template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: templateId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: basic
      username: '{{env.CISCO_VOICE_PORTAL_USER}}'
      password: '{{env.CISCO_VOICE_PORTAL_PASS}}'
  exposes:
  - type: rest
    namespace: reporting-report-templates-rest
    port: 8080
    description: REST adapter for Cisco Voice Portal Reporting API — Report Templates. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/report
      name: report
      description: REST surface for report.
      operations:
      - method: GET
        name: listreporttemplates
        description: Cisco Voice Portal List Available Report Templates
        call: reporting-report-templates.listreporttemplates
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/report/{reportid}/result
      name: report-reportid-result
      description: REST surface for report-reportId-result.
      operations:
      - method: GET
        name: getreportresult
        description: Cisco Voice Portal Get Report Execution Result
        call: reporting-report-templates.getreportresult
        with:
          reportId: rest.reportId
          format: rest.format
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/report/{templateid}/execute
      name: report-templateid-execute
      description: REST surface for report-templateId-execute.
      operations:
      - method: POST
        name: executereport
        description: Cisco Voice Portal Execute a Report Template
        call: reporting-report-templates.executereport
        with:
          templateId: rest.templateId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: reporting-report-templates-mcp
    port: 9090
    transport: http
    description: MCP adapter for Cisco Voice Portal Reporting API — Report Templates. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: cisco-voice-portal-list-available
      description: Cisco Voice Portal List Available Report Templates
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: reporting-report-templates.listreporttemplates
      outputParameters:
      - type: object
        mapping: $.
    - name: cisco-voice-portal-get-report
      description: Cisco Voice Portal Get Report Execution Result
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: reporting-report-templates.getreportresult
      with:
        reportId: tools.reportId
        format: tools.format
      outputParameters:
      - type: object
        mapping: $.
    - name: cisco-voice-portal-execute-report
      description: Cisco Voice Portal Execute a Report Template
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: reporting-report-templates.executereport
      with:
        templateId: tools.templateId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.