Factset Documents Distributor - Documents API — Asynch

naftiko: 1.0.0-alpha2
info:
  label: Factset Documents Distributor - Documents API — Asynch
  description: 'Factset Documents Distributor - Documents API — Asynch. 6 operations. Lead operation: Factset Returns the
    status and percentDone of the requested jobID and source. Self-contained Naftiko capability covering one Factset business
    surface.'
  tags:
  - Factset
  - Asynch
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: documents-distributor-documents-asynch
    baseUri: https://api.factset.com/bulk-documents
    description: Factset Documents Distributor - Documents API — Asynch business capability. Self-contained, no shared references.
    resources:
    - name: asynch-news-v1-check-status
      path: /asynch/news/v1/check-status
      operations:
      - name: get
        method: GET
        description: Factset Returns the status and percentDone of the requested jobID and source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobID
          in: query
          type: string
          description: jobID returned by the request-files endpoint to know the status and percentDone
          required: true
        - name: source
          in: query
          type: string
          description: This parameter filters the results based on the source of the filings document
          required: true
        - name: _paginationLimit
          in: query
          type: integer
          description: Specifies the maximum number of results to return per result
        - name: _paginationOffset
          in: query
          type: integer
          description: Specifies the starting point for pagination. This parameter is used to identify the   beginning of
            next set of results
    - name: asynch-news-v1-get-files
      path: /asynch/news/v1/get-files
      operations:
      - name: get
        method: GET
        description: Factset Returns the news filings for the specified daterange and source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobID
          in: query
          type: string
          description: jobID returned by the request-files endpoint to collect the results of the query
          required: true
        - name: source
          in: query
          type: string
          description: This parameter filters the results based on the source of the filings document
          required: true
        - name: _paginationLimit
          in: query
          type: integer
          description: Specifies the maximum number of results to return per result
        - name: _paginationOffset
          in: query
          type: integer
          description: Specifies the starting point for pagination. This parameter is used to identify the   beginning of
            next set of results
    - name: asynch-news-v1-request-files
      path: /asynch/news/v1/request-files
      operations:
      - name: get
        method: GET
        description: Factset Returns the jobID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startDate
          in: query
          type: string
          description: Date from which data is required. Should be YYYY-MM-DDTHH:MM:SSZ format
          required: true
        - name: endDate
          in: query
          type: string
          description: The date until which the data is to be fetched. Should be YYYY-MM-DDTHH:MM:SSZ format
          required: true
        - name: source
          in: query
          type: string
          description: This parameter filters the results based on the source of the filings document
          required: true
    - name: asynch-streetaccount-v1-check-status
      path: /asynch/streetaccount/v1/check-status
      operations:
      - name: get
        method: GET
        description: Factset Returns the status and percentDone of the requested jobID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobID
          in: query
          type: string
          description: jobID returned by the request-files endpoint to know the status and percentDone
          required: true
        - name: _paginationLimit
          in: query
          type: integer
          description: Specifies the maximum number of results to return per result
        - name: _paginationOffset
          in: query
          type: integer
          description: Specifies the starting point for pagination. This parameter is used to identify the   beginning of
            next set of results
    - name: asynch-streetaccount-v1-get-files
      path: /asynch/streetaccount/v1/get-files
      operations:
      - name: get
        method: GET
        description: Factset Returns the SA XML files for the specified daterange
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobID
          in: query
          type: string
          description: jobID returned by the request-files endpoint to collect the results of the query
          required: true
        - name: _paginationLimit
          in: query
          type: integer
          description: Specifies the maximum number of results to return per result
        - name: _paginationOffset
          in: query
          type: integer
          description: Specifies the starting point for pagination. This parameter is used to identify the   beginning of
            next set of results
    - name: asynch-streetaccount-v1-request-files
      path: /asynch/streetaccount/v1/request-files
      operations:
      - name: get
        method: GET
        description: Factset Returns the jobID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startDate
          in: query
          type: string
          description: Date from which data is required. Should be YYYY-MM-DDTHH:MM:SSZ format
          required: true
        - name: endDate
          in: query
          type: string
          description: The date until which the data is to be fetched. Should be YYYY-MM-DDTHH:MM:SSZ format
          required: true
    authentication:
      type: basic
      username: '{{env.FACTSET_USER}}'
      password: '{{env.FACTSET_PASS}}'
  exposes:
  - type: rest
    namespace: documents-distributor-documents-asynch-rest
    port: 8080
    description: REST adapter for Factset Documents Distributor - Documents API — Asynch. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/asynch/news/v1/check-status
      name: asynch-news-v1-check-status
      description: REST surface for asynch-news-v1-check-status.
      operations:
      - method: GET
        name: get
        description: Factset Returns the status and percentDone of the requested jobID and source
        call: documents-distributor-documents-asynch.get
        with:
          jobID: rest.jobID
          source: rest.source
          _paginationLimit: rest._paginationLimit
          _paginationOffset: rest._paginationOffset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/asynch/news/v1/get-files
      name: asynch-news-v1-get-files
      description: REST surface for asynch-news-v1-get-files.
      operations:
      - method: GET
        name: get
        description: Factset Returns the news filings for the specified daterange and source
        call: documents-distributor-documents-asynch.get
        with:
          jobID: rest.jobID
          source: rest.source
          _paginationLimit: rest._paginationLimit
          _paginationOffset: rest._paginationOffset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/asynch/news/v1/request-files
      name: asynch-news-v1-request-files
      description: REST surface for asynch-news-v1-request-files.
      operations:
      - method: GET
        name: get
        description: Factset Returns the jobID
        call: documents-distributor-documents-asynch.get
        with:
          startDate: rest.startDate
          endDate: rest.endDate
          source: rest.source
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/asynch/streetaccount/v1/check-status
      name: asynch-streetaccount-v1-check-status
      description: REST surface for asynch-streetaccount-v1-check-status.
      operations:
      - method: GET
        name: get
        description: Factset Returns the status and percentDone of the requested jobID
        call: documents-distributor-documents-asynch.get
        with:
          jobID: rest.jobID
          _paginationLimit: rest._paginationLimit
          _paginationOffset: rest._paginationOffset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/asynch/streetaccount/v1/get-files
      name: asynch-streetaccount-v1-get-files
      description: REST surface for asynch-streetaccount-v1-get-files.
      operations:
      - method: GET
        name: get
        description: Factset Returns the SA XML files for the specified daterange
        call: documents-distributor-documents-asynch.get
        with:
          jobID: rest.jobID
          _paginationLimit: rest._paginationLimit
          _paginationOffset: rest._paginationOffset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/asynch/streetaccount/v1/request-files
      name: asynch-streetaccount-v1-request-files
      description: REST surface for asynch-streetaccount-v1-request-files.
      operations:
      - method: GET
        name: get
        description: Factset Returns the jobID
        call: documents-distributor-documents-asynch.get
        with:
          startDate: rest.startDate
          endDate: rest.endDate
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: documents-distributor-documents-asynch-mcp
    port: 9090
    transport: http
    description: MCP adapter for Factset Documents Distributor - Documents API — Asynch. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: factset-returns-status-and-percentdone
      description: Factset Returns the status and percentDone of the requested jobID and source
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: documents-distributor-documents-asynch.get
      with:
        jobID: tools.jobID
        source: tools.source
        _paginationLimit: tools._paginationLimit
        _paginationOffset: tools._paginationOffset
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-news-filings-specified
      description: Factset Returns the news filings for the specified daterange and source
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: documents-distributor-documents-asynch.get
      with:
        jobID: tools.jobID
        source: tools.source
        _paginationLimit: tools._paginationLimit
        _paginationOffset: tools._paginationOffset
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-jobid
      description: Factset Returns the jobID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: documents-distributor-documents-asynch.get
      with:
        startDate: tools.startDate
        endDate: tools.endDate
        source: tools.source
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-status-and-percentdone-2
      description: Factset Returns the status and percentDone of the requested jobID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: documents-distributor-documents-asynch.get
      with:
        jobID: tools.jobID
        _paginationLimit: tools._paginationLimit
        _paginationOffset: tools._paginationOffset
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-sa-xml-files
      description: Factset Returns the SA XML files for the specified daterange
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: documents-distributor-documents-asynch.get
      with:
        jobID: tools.jobID
        _paginationLimit: tools._paginationLimit
        _paginationOffset: tools._paginationOffset
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-returns-jobid-2
      description: Factset Returns the jobID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: documents-distributor-documents-asynch.get
      with:
        startDate: tools.startDate
        endDate: tools.endDate
      outputParameters:
      - type: object
        mapping: $.