SAP Crystal Reports RESTful Web Services API — Instances

naftiko: 1.0.0-alpha2
info:
  label: SAP Crystal Reports RESTful Web Services API — Instances
  description: 'SAP Crystal Reports RESTful Web Services API — Instances. 2 operations. Lead operation: Crystal Reports Get
    Instance Creation Form. Self-contained Naftiko capability covering one Crystal Reports business surface.'
  tags:
  - Crystal Reports
  - Instances
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CRYSTAL_REPORTS_API_KEY: CRYSTAL_REPORTS_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-instances
    baseUri: http://{host}:{port}/biprws
    description: SAP Crystal Reports RESTful Web Services API — Instances business capability. Self-contained, no shared references.
    resources:
    - name: infostore-reportId-rpt-instance
      path: /infostore/{reportId}/rpt/instance
      operations:
      - name: getinstanceform
        method: GET
        description: Crystal Reports Get Instance Creation Form
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createreportinstance
        method: POST
        description: Crystal Reports Create Transient Report Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: X-SAP-LogonToken
      value: '{{env.CRYSTAL_REPORTS_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-instances-rest
    port: 8080
    description: REST adapter for SAP Crystal Reports RESTful Web Services API — Instances. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/infostore/{reportid}/rpt/instance
      name: infostore-reportid-rpt-instance
      description: REST surface for infostore-reportId-rpt-instance.
      operations:
      - method: GET
        name: getinstanceform
        description: Crystal Reports Get Instance Creation Form
        call: rest-instances.getinstanceform
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createreportinstance
        description: Crystal Reports Create Transient Report Instance
        call: rest-instances.createreportinstance
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-instances-mcp
    port: 9090
    transport: http
    description: MCP adapter for SAP Crystal Reports RESTful Web Services API — Instances. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: crystal-reports-get-instance-creation
      description: Crystal Reports Get Instance Creation Form
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-instances.getinstanceform
      outputParameters:
      - type: object
        mapping: $.
    - name: crystal-reports-create-transient-report
      description: Crystal Reports Create Transient Report Instance
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-instances.createreportinstance
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.