FactSet Vermilion API — Results

naftiko: 1.0.0-alpha2
info:
  label: FactSet Vermilion API — Results
  description: 'FactSet Vermilion API — Results. 1 operations. Lead operation: Factset Gets the Generated File. Self-contained
    Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - Results
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: vermilion-results
    baseUri: ''
    description: FactSet Vermilion API — Results business capability. Self-contained, no shared references.
    resources:
    - name: v1-tenant-report-instances-reportInstanceId-results-reportFileName
      path: /v1/{tenant}/report-instances/{reportInstanceId}/results/{reportFileName}
      operations:
      - name: getreportfile
        method: GET
        description: Factset Gets the Generated File
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: tenant
          in: path
          type: string
          description: The code of the tenancy
          required: true
        - name: reportInstanceId
          in: path
          type: string
          description: Used to validate that report file name belongs to the report instance passed
          required: true
        - name: reportFileName
          in: path
          type: string
          description: 'The report file name that has to be retrieved. report file name. E.g: xyz.pdf'
          required: true
    authentication:
      type: bearer
      token: '{{env.FACTSET_API_KEY}}'
  exposes:
  - type: rest
    namespace: vermilion-results-rest
    port: 8080
    description: REST adapter for FactSet Vermilion API — Results. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/{tenant}/report-instances/{reportinstanceid}/results/{reportfilename}
      name: v1-tenant-report-instances-reportinstanceid-results-reportfilename
      description: REST surface for v1-tenant-report-instances-reportInstanceId-results-reportFileName.
      operations:
      - method: GET
        name: getreportfile
        description: Factset Gets the Generated File
        call: vermilion-results.getreportfile
        with:
          tenant: rest.tenant
          reportInstanceId: rest.reportInstanceId
          reportFileName: rest.reportFileName
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: vermilion-results-mcp
    port: 9090
    transport: http
    description: MCP adapter for FactSet Vermilion API — Results. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: factset-gets-generated-file
      description: Factset Gets the Generated File
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vermilion-results.getreportfile
      with:
        tenant: tools.tenant
        reportInstanceId: tools.reportInstanceId
        reportFileName: tools.reportFileName
      outputParameters:
      - type: object
        mapping: $.