Factset Instance API

openapi: 3.2.0
info:
  version: 1.0.0
  title: FactSet Vermilion Instance API
  contact:
    name: FactSet Research Systems
    email: api@factset.com
    url: https://developer.factset.com/contact
  license:
    name: Apache License, Version 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  description: '

    The Vermilion API, enables users to programmatically access FactSet''s

    Vermilion Reporting Suite (VRS) and seamlessly integrate into customer''s

    3rd party applications. The API is referred to as two key product

    initiatives, the REST API and the SCIM API.'
security:
- FactSetApiKey: []
- FactSetOAuth2: []
tags:
- name: Instance
paths:
  /v1/{tenant}/report-instances/{reportInstanceId}:
    delete:
      operationId: cancelReport
      tags:
      - Instance
      summary: Factset Cancels a Report Generation
      description: Sends a request to cancel a report generation based on the report instance id passed
      parameters:
      - in: path
        name: tenant
        description: The code of the tenancy
        schema:
          type: string
        required: true
      - in: path
        name: reportInstanceId
        description: The id of the report instance
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successful operation - no response
        '400':
          description: The supplied report instance id was either missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - id: ID of the error
                  code: parameterError
                  title: The ID passed is not a numerical value
        '401':
          description: Unauthorised
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - id: ID of the error
                  code: notAuthenticated
                  title: User is not authenticated
        '403':
          description: No permissions to view reports in VRS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - id: ID of the error
                  code: notAuthorized
                  title: No permissions to view this item
        '404':
          description: The supplied report instance ID could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - id: ID of the error
                  code: notFound
                  title: The report definition code passed was not found
        '406':
          description: Unsupported Accept header. Header needs to be set to application/json.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - id: ID of the error
                  code: notAcceptable
                  title: Unsupported Accept header. Header needs to be set to application/json
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: getReportInstanceById
      tags:
      - Instance
      summary: Factset Gets a Report Instance Based on the Id
      description: Gets a report instance object based on the ID passed
      parameters:
      - in: path
        name: reportInstanceId
        description: The ID of the report instance
        schema:
          type: string
        required: true
      - in: path
        name: tenant
        description: The code of the tenancy
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Report generation has completed and the report is ready to download
          headers:
            Location:
              schema:
                type: string
              description: A callback URL to the report file on VRS ready to download
        '202':
          description: Expected response returned if the report generation is not yet completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportInstanceData'
        '400':
          description: The supplied report instance id was either missing or invalid, or the report instance was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - id: ID of the error
                  code: parameterError
                  title: The ID passed is not a numerical value
        '401':
          description: Unauthorised
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - id: ID of the error
                  code: notAuthenticated
                  title: User is not authenticated
        '403':
          description: No permissions to view reports in VRS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - id: ID of the error
                  code: notAuthorized
                  title: No permissions to view this item
        '404':
          description: The supplied report instance ID could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - id: ID of the error
                  code: notFound
                  title: The report definition code passed was not found
        '406':
          description: Unsupported Accept header. Header needs to be set to application/json.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - id: ID of the error
                  code: notAcceptable
                  title: Unsupported Accept header. Header needs to be set to application/json
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/{tenant}/report-instances/{reportInstanceId}/logs:
    get:
      operationId: getReportGenerationLogs
      tags:
      - Instance
      summary: Factset Gets a List of Logs for the Report Instance Generation
      description: Gets a list of logs for the generated report instance. Allows the user to sort on log message, type and date. Also allows for retrieving of just the errors & warnings'
      parameters:
      - in: path
        name: tenant
        description: The code of the tenancy
        schema:
          type: string
        required: true
      - in: path
        name: reportInstanceId
        description: Used to validate that report file name belongs to the report instance passed
        schema:
          type: string
        required: true
      - in: query
        name: errorsOnly
        description: 'If the parameter is set to true the endpoint should return just errors and warnings E.g: errorsOnly=true'
        schema:
          type: string
      - in: query
        name: _sort
        description: The column to sort on. Can add - to sort
        required: false
        style: form
        explode: false
        schema:
          type: array
          maxItems: 1
          items:
            type: string
        examples:
          sequenceNumber:
            value:
            - sequenceNumber
            description: The sequence number of the log entry
          message:
            value:
            - message
            description: The log message to sort
          type:
            value:
            - type
            description: The type of the log to sort
          updatedDate:
            value:
            - updatdeDate
            description: The updated date of the log to sort
      - in: query
        name: _paginationLimit
        description: Non-negative maximum number of entries to return
        schema:
          type: integer
        examples:
          pageSize:
            value: 25
            description: Non-negative maximum number of entries to return
      - in: query
        name: _paginationOffset
        description: Non-negative number of entries to skip
        schema:
          type: integer
        examples:
          startIndex:
            value: 0
            description: Non-negative maximum number of entries to return
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportInstanceLogList'
        '401':
          description: Unauthorised
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - id: ID of the error
                  code: notAuthenticated
                  title: User is not authenticated
        '403':
          description: No permissions to view reports in VRS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - id: ID of the error
                  code: notAuthorized
                  title: No permissions to view this item
        '404':
          description: The supplied report instance ID could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - id: ID of the error
                  code: notFound
                  title: The report instance ID passed was not found
        '406':
          description: Unsupported Accept header. Header needs to be set to application/json.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - id: ID of the error
                  code: notAcceptable
                  title: "Unsupported Accept header. Header needs to be set to\n    application/json"
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ReportInstanceData:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ReportInstanceDTO'
    ReportInstanceLogList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ReportInstanceLogDTO'
          example: []
    ErrorList:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          example: []
    ReportRevisionDTO:
      type: object
      properties:
        reportStatus:
          type: string
          enum:
          - WAITING
          - STARTING
          - RETRIEVING_REQUEST
          - CONTENT_FILTER
          - STYLE_PROCESSING
          - RULE_PROCESSING
          - GETTING_DATA
          - RI_PROCESSING
          - COMPILE
          - SUBSTITUTION
          - TRANSLATION
          - GRID_PROCESSING
          - CHART_PROCESSING
          - IMPORTED_FILE_PROCESSING
          - TEXT_PROCESSING_STATUS
          - TOC_PROCESSING_STATUS
          - COMPONENT_PROCESSING
          - POST_PROCESSING
          - POSTING_TO_WRS
          - RENDERING
          - ABORTED
          - COMPLETED
          - COMPLETED_CAUTIONS
          - COMPLETED_ERROR
          - COMPLETED_MODIFYING
          - COMPLETED_CHANGED
          - DELETING
          - REPORT_ORIGINAL_GENERATION
          - REPORT_PREVIOUS_REVISION
          - GENERATING
          example: WAITING
        startDate:
          type: string
          example: example_value
        finishDate:
          type: string
          example: example_value
        signOffStatus:
          type: string
          enum:
          - REJECTED
          - PENDING
          - APPROVED
          example: REJECTED
        signOffNotes:
          type: string
          example: example_value
        reportReasonCd:
          type: string
          example: example_value
        description:
          type: string
          example: A sample description.
        languageCode:
          type: string
          example: example_value
        outputFormat:
          type: string
          example: example_value
        percentageComplete:
          type: integer
          format: int32
          example: 10
    ReportInstanceLogDTO:
      type: object
      properties:
        sequenceNumber:
          type: integer
          format: int32
          example: 10
        message:
          type: string
          example: example_value
        type:
          type: string
          enum:
          - LOG
          - ERROR
          example: LOG
        updateDate:
          type: string
          example: example_value
    Error:
      type: object
      properties:
        id:
          type: string
          example: abc123
        code:
          type: string
          example: example_value
        title:
          type: string
          example: Example Title
    ReportInstanceDTO:
      type: object
      properties:
        reportInstanceId:
          type: integer
          format: int32
          example: '500123'
        reportDefinitionId:
          type: integer
          format: int32
          example: '500123'
        reportDefinitionName:
          type: string
          example: example_value
        reportName:
          type: string
          example: example_value
        userFriendlyReportName:
          type: string
          example: example_value
        extension:
          type: string
          example: example_value
        reportRevision:
          $ref: '#/components/schemas/ReportRevisionDTO'
        name:
          type: string
          example: Example Title
  securitySchemes:
    FactSetOAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.factset.com/as/token.oauth2
          scopes: {}
    FactSetApiKey:
      type: http
      scheme: basic
externalDocs:
  description: API Documentation
  url: https://developer.factset.com/api-catalog/vermilion-api