Factset Vault API — Analytics

naftiko: 1.0.0-alpha2
info:
  label: Factset Vault API — Analytics
  description: 'Factset Vault API — Analytics. 14 operations. Lead operation: Factset Create and Run Vault calculation. Self-contained
    Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - Analytics
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: vault-analytics-2
    baseUri: https://api.factset.com
    description: Factset Vault API — Analytics business capability. Self-contained, no shared references.
    resources:
    - name: analytics-engines-vault-v3-calculations
      path: /analytics/engines/vault/v3/calculations
      operations:
      - name: postandcalculate
        method: POST
        description: Factset Create and Run Vault calculation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-FactSet-Api-Long-Running-Deadline
          in: header
          type: integer
          description: Long running deadline in seconds when only one unit is passed in the POST body.
        - name: Cache-Control
          in: header
          type: string
          description: Standard HTTP header.  Accepts max-stale.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getallcalculations
        method: GET
        description: Factset Get all calculations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: pageNumber
          in: query
          type: integer
    - name: analytics-engines-vault-v3-calculations-id
      path: /analytics/engines/vault/v3/calculations/{id}
      operations:
      - name: putandcalculate
        method: PUT
        description: Factset Create or Update Vault calculation and run it.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: from url, provided from the location header in the Create and Run Vault calculation endpoint
          required: true
        - name: X-FactSet-Api-Long-Running-Deadline
          in: header
          type: integer
          description: Long running deadline in seconds when only one unit is passed in the PUT body.
        - name: Cache-Control
          in: header
          type: string
          description: Standard HTTP header.  Accepts max-stale.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getcalculationparameters
        method: GET
        description: Factset Get Vault calculation parameters by id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: from url, provided from the location header in the Create and Run Vault calculation endpoint
          required: true
      - name: cancelcalculationbyid
        method: DELETE
        description: Factset Cancel Vault calculation by id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: from url, provided from the location header in the Create and Run Vault calculation endpoint
          required: true
    - name: analytics-engines-vault-v3-calculations-id-status
      path: /analytics/engines/vault/v3/calculations/{id}/status
      operations:
      - name: getcalculationstatusbyid
        method: GET
        description: Factset Get Vault calculation status by id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: from url, provided from the location header in the Create and Run Vault calculation endpoint
          required: true
    - name: analytics-engines-vault-v3-calculations-id-units-unitId-result
      path: /analytics/engines/vault/v3/calculations/{id}/units/{unitId}/result
      operations:
      - name: getcalculationunitresultbyid
        method: GET
        description: Factset Get Vault calculation result by id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: from url, provided from the location header in the Get Vault calculation status by id endpoint
          required: true
        - name: unitId
          in: path
          type: string
          description: from url, provided from the location header in the Get Vault calculation status by id endpoint
          required: true
    - name: analytics-engines-vault-v3-components
      path: /analytics/engines/vault/v3/components
      operations:
      - name: getvaultcomponents
        method: GET
        description: Factset Get Vault components
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: document
          in: query
          type: string
          description: Document Name
          required: true
    - name: analytics-engines-vault-v3-components-id
      path: /analytics/engines/vault/v3/components/{id}
      operations:
      - name: getvaultcomponentbyid
        method: GET
        description: Factset Get Vault component by id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Unique identifier for a vault component
          required: true
    - name: analytics-engines-vault-v3-configurations
      path: /analytics/engines/vault/v3/configurations
      operations:
      - name: getvaultconfigurations
        method: GET
        description: Factset Get Vault configurations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account
          in: query
          type: string
          description: Required account query parameter to filter configurations for a specific account
          required: true
    - name: analytics-engines-vault-v3-configurations-id
      path: /analytics/engines/vault/v3/configurations/{id}
      operations:
      - name: getvaultconfigurationbyid
        method: GET
        description: Factset Get Vault configuration by id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Vault configuration id to get the details of
          required: true
    - name: analytics-engines-vault-v3-dates
      path: /analytics/engines/vault/v3/dates
      operations:
      - name: convertvaultdatestoabsoluteformat
        method: GET
        description: Factset Convert Vault dates to absolute format
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startdate
          in: query
          type: string
          description: Start Date
        - name: enddate
          in: query
          type: string
          description: End Date
          required: true
        - name: componentid
          in: query
          type: string
          description: Vault Component Id
          required: true
        - name: account
          in: query
          type: string
          description: Account
          required: true
    - name: analytics-engines-vault-v3-documents-path
      path: /analytics/engines/vault/v3/documents/{path}
      operations:
      - name: getvaultdocuments
        method: GET
        description: Factset Get Vault documents and sub-directories in a directory
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: path
          in: path
          type: string
          description: The directory to get the documents in
          required: true
    - name: analytics-engines-vault-v3-frequencies
      path: /analytics/engines/vault/v3/frequencies
      operations:
      - name: getvaultfrequencies
        method: GET
        description: Factset Get Vault frequencies
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.FACTSET_API_KEY}}'
  exposes:
  - type: rest
    namespace: vault-analytics-2-rest
    port: 8080
    description: REST adapter for Factset Vault API — Analytics. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/analytics/engines/vault/v3/calculations
      name: analytics-engines-vault-v3-calculations
      description: REST surface for analytics-engines-vault-v3-calculations.
      operations:
      - method: POST
        name: postandcalculate
        description: Factset Create and Run Vault calculation
        call: vault-analytics-2.postandcalculate
        with:
          X-FactSet-Api-Long-Running-Deadline: rest.X-FactSet-Api-Long-Running-Deadline
          Cache-Control: rest.Cache-Control
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getallcalculations
        description: Factset Get all calculations
        call: vault-analytics-2.getallcalculations
        with:
          pageNumber: rest.pageNumber
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/vault/v3/calculations/{id}
      name: analytics-engines-vault-v3-calculations-id
      description: REST surface for analytics-engines-vault-v3-calculations-id.
      operations:
      - method: PUT
        name: putandcalculate
        description: Factset Create or Update Vault calculation and run it.
        call: vault-analytics-2.putandcalculate
        with:
          id: rest.id
          X-FactSet-Api-Long-Running-Deadline: rest.X-FactSet-Api-Long-Running-Deadline
          Cache-Control: rest.Cache-Control
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getcalculationparameters
        description: Factset Get Vault calculation parameters by id
        call: vault-analytics-2.getcalculationparameters
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: cancelcalculationbyid
        description: Factset Cancel Vault calculation by id
        call: vault-analytics-2.cancelcalculationbyid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/vault/v3/calculations/{id}/status
      name: analytics-engines-vault-v3-calculations-id-status
      description: REST surface for analytics-engines-vault-v3-calculations-id-status.
      operations:
      - method: GET
        name: getcalculationstatusbyid
        description: Factset Get Vault calculation status by id
        call: vault-analytics-2.getcalculationstatusbyid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/vault/v3/calculations/{id}/units/{unitid}/result
      name: analytics-engines-vault-v3-calculations-id-units-unitid-result
      description: REST surface for analytics-engines-vault-v3-calculations-id-units-unitId-result.
      operations:
      - method: GET
        name: getcalculationunitresultbyid
        description: Factset Get Vault calculation result by id
        call: vault-analytics-2.getcalculationunitresultbyid
        with:
          id: rest.id
          unitId: rest.unitId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/vault/v3/components
      name: analytics-engines-vault-v3-components
      description: REST surface for analytics-engines-vault-v3-components.
      operations:
      - method: GET
        name: getvaultcomponents
        description: Factset Get Vault components
        call: vault-analytics-2.getvaultcomponents
        with:
          document: rest.document
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/vault/v3/components/{id}
      name: analytics-engines-vault-v3-components-id
      description: REST surface for analytics-engines-vault-v3-components-id.
      operations:
      - method: GET
        name: getvaultcomponentbyid
        description: Factset Get Vault component by id
        call: vault-analytics-2.getvaultcomponentbyid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/vault/v3/configurations
      name: analytics-engines-vault-v3-configurations
      description: REST surface for analytics-engines-vault-v3-configurations.
      operations:
      - method: GET
        name: getvaultconfigurations
        description: Factset Get Vault configurations
        call: vault-analytics-2.getvaultconfigurations
        with:
          account: rest.account
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/vault/v3/configurations/{id}
      name: analytics-engines-vault-v3-configurations-id
      description: REST surface for analytics-engines-vault-v3-configurations-id.
      operations:
      - method: GET
        name: getvaultconfigurationbyid
        description: Factset Get Vault configuration by id
        call: vault-analytics-2.getvaultconfigurationbyid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/vault/v3/dates
      name: analytics-engines-vault-v3-dates
      description: REST surface for analytics-engines-vault-v3-dates.
      operations:
      - method: GET
        name: convertvaultdatestoabsoluteformat
        description: Factset Convert Vault dates to absolute format
        call: vault-analytics-2.convertvaultdatestoabsoluteformat
        with:
          startdate: rest.startdate
          enddate: rest.enddate
          componentid: rest.componentid
          account: rest.account
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/vault/v3/documents/{path}
      name: analytics-engines-vault-v3-documents-path
      description: REST surface for analytics-engines-vault-v3-documents-path.
      operations:
      - method: GET
        name: getvaultdocuments
        description: Factset Get Vault documents and sub-directories in a directory
        call: vault-analytics-2.getvaultdocuments
        with:
          path: rest.path
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/engines/vault/v3/frequencies
      name: analytics-engines-vault-v3-frequencies
      description: REST surface for analytics-engines-vault-v3-frequencies.
      operations:
      - method: GET
        name: getvaultfrequencies
        description: Factset Get Vault frequencies
        call: vault-analytics-2.getvaultfrequencies
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: vault-analytics-2-mcp
    port: 9090
    transport: http
    description: MCP adapter for Factset Vault API — Analytics. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: factset-create-and-run-vault
      description: Factset Create and Run Vault calculation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: vault-analytics-2.postandcalculate
      with:
        X-FactSet-Api-Long-Running-Deadline: tools.X-FactSet-Api-Long-Running-Deadline
        Cache-Control: tools.Cache-Control
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-all-calculations
      description: Factset Get all calculations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vault-analytics-2.getallcalculations
      with:
        pageNumber: tools.pageNumber
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-create-update-vault-calculation
      description: Factset Create or Update Vault calculation and run it.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: vault-analytics-2.putandcalculate
      with:
        id: tools.id
        X-FactSet-Api-Long-Running-Deadline: tools.X-FactSet-Api-Long-Running-Deadline
        Cache-Control: tools.Cache-Control
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-vault-calculation-parameters
      description: Factset Get Vault calculation parameters by id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vault-analytics-2.getcalculationparameters
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-cancel-vault-calculation-id
      description: Factset Cancel Vault calculation by id
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: vault-analytics-2.cancelcalculationbyid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-vault-calculation-status
      description: Factset Get Vault calculation status by id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vault-analytics-2.getcalculationstatusbyid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-vault-calculation-result
      description: Factset Get Vault calculation result by id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vault-analytics-2.getcalculationunitresultbyid
      with:
        id: tools.id
        unitId: tools.unitId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-vault-components
      description: Factset Get Vault components
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vault-analytics-2.getvaultcomponents
      with:
        document: tools.document
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-vault-component-id
      description: Factset Get Vault component by id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vault-analytics-2.getvaultcomponentbyid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-vault-configurations
      description: Factset Get Vault configurations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vault-analytics-2.getvaultconfigurations
      with:
        account: tools.account
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-vault-configuration-id
      description: Factset Get Vault configuration by id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vault-analytics-2.getvaultconfigurationbyid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-convert-vault-dates-absolute
      description: Factset Convert Vault dates to absolute format
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vault-analytics-2.convertvaultdatestoabsoluteformat
      with:
        startdate: tools.startdate
        enddate: tools.enddate
        componentid: tools.componentid
        account: tools.account
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-vault-documents-and
      description: Factset Get Vault documents and sub-directories in a directory
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vault-analytics-2.getvaultdocuments
      with:
        path: tools.path
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-vault-frequencies
      description: Factset Get Vault frequencies
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: vault-analytics-2.getvaultfrequencies
      outputParameters:
      - type: object
        mapping: $.