Cisco Voice Portal Administration API — Dialed Number Patterns

naftiko: 1.0.0-alpha2
info:
  label: Cisco Voice Portal Administration API — Dialed Number Patterns
  description: 'Cisco Voice Portal Administration API — Dialed Number Patterns. 5 operations. Lead operation: Cisco Voice
    Portal List Dialed Number Patterns. Self-contained Naftiko capability covering one Cisco Voice Portal business surface.'
  tags:
  - Cisco Voice Portal
  - Dialed Number Patterns
  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: administration-dialed-number-patterns
    baseUri: https://{oamp-server}:9443/oamp/rest
    description: Cisco Voice Portal Administration API — Dialed Number Patterns business capability. Self-contained, no shared
      references.
    resources:
    - name: dialedNumberPattern
      path: /dialedNumberPattern
      operations:
      - name: listdialednumberpatterns
        method: GET
        description: Cisco Voice Portal List Dialed Number Patterns
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createdialednumberpattern
        method: POST
        description: Cisco Voice Portal Create a Dialed Number Pattern
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: dialedNumberPattern-patternId
      path: /dialedNumberPattern/{patternId}
      operations:
      - name: getdialednumberpattern
        method: GET
        description: Cisco Voice Portal Get Dialed Number Pattern Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: patternId
          in: path
          type: string
          required: true
      - name: updatedialednumberpattern
        method: PUT
        description: Cisco Voice Portal Update a Dialed Number Pattern
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: patternId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletedialednumberpattern
        method: DELETE
        description: Cisco Voice Portal Delete a Dialed Number Pattern
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: patternId
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: JSESSIONID
      value: '{{env.CISCO_VOICE_PORTAL_API_KEY}}'
      placement: cookie
  exposes:
  - type: rest
    namespace: administration-dialed-number-patterns-rest
    port: 8080
    description: REST adapter for Cisco Voice Portal Administration API — Dialed Number Patterns. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/dialednumberpattern
      name: dialednumberpattern
      description: REST surface for dialedNumberPattern.
      operations:
      - method: GET
        name: listdialednumberpatterns
        description: Cisco Voice Portal List Dialed Number Patterns
        call: administration-dialed-number-patterns.listdialednumberpatterns
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createdialednumberpattern
        description: Cisco Voice Portal Create a Dialed Number Pattern
        call: administration-dialed-number-patterns.createdialednumberpattern
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dialednumberpattern/{patternid}
      name: dialednumberpattern-patternid
      description: REST surface for dialedNumberPattern-patternId.
      operations:
      - method: GET
        name: getdialednumberpattern
        description: Cisco Voice Portal Get Dialed Number Pattern Details
        call: administration-dialed-number-patterns.getdialednumberpattern
        with:
          patternId: rest.patternId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatedialednumberpattern
        description: Cisco Voice Portal Update a Dialed Number Pattern
        call: administration-dialed-number-patterns.updatedialednumberpattern
        with:
          patternId: rest.patternId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletedialednumberpattern
        description: Cisco Voice Portal Delete a Dialed Number Pattern
        call: administration-dialed-number-patterns.deletedialednumberpattern
        with:
          patternId: rest.patternId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: administration-dialed-number-patterns-mcp
    port: 9090
    transport: http
    description: MCP adapter for Cisco Voice Portal Administration API — Dialed Number Patterns. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: cisco-voice-portal-list-dialed
      description: Cisco Voice Portal List Dialed Number Patterns
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: administration-dialed-number-patterns.listdialednumberpatterns
      outputParameters:
      - type: object
        mapping: $.
    - name: cisco-voice-portal-create-dialed
      description: Cisco Voice Portal Create a Dialed Number Pattern
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: administration-dialed-number-patterns.createdialednumberpattern
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: cisco-voice-portal-get-dialed
      description: Cisco Voice Portal Get Dialed Number Pattern Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: administration-dialed-number-patterns.getdialednumberpattern
      with:
        patternId: tools.patternId
      outputParameters:
      - type: object
        mapping: $.
    - name: cisco-voice-portal-update-dialed
      description: Cisco Voice Portal Update a Dialed Number Pattern
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: administration-dialed-number-patterns.updatedialednumberpattern
      with:
        patternId: tools.patternId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: cisco-voice-portal-delete-dialed
      description: Cisco Voice Portal Delete a Dialed Number Pattern
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: administration-dialed-number-patterns.deletedialednumberpattern
      with:
        patternId: tools.patternId
      outputParameters:
      - type: object
        mapping: $.