Factset Reports API

openapi: 3.2.0
info:
  version: 1.0.0
  title: FactSet Vermilion Reports 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: Reports
paths:
  /v1/{tenant}/reports:
    get:
      operationId: getAllReportDefinitions
      tags:
      - Reports
      summary: Factset Gets All Report Definitions
      description: Gets all report definitions the user has permissions for
      parameters:
      - in: path
        name: tenant
        description: The code of the tenancy
        schema:
          type: string
        required: true
      - 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:
          name:
            value:
            - name
            description: The name of the report to sort
          type:
            value:
            - templateOwner
            description: The template owner of the report to sort
          code:
            value:
            - code
            description: The code of the report to sort
          releaseTag:
            value:
            - releaseTag
            description: The release tag of the report to sort
          lastUpdatedBy:
            value:
            - lastUpdatedBy
            description: The last updated by user of the report to sort
          lastModifiedBy:
            value:
            - lastModifiedBy
            description: The last updated by date of the report 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/ReportDefinitionList'
        '400':
          description: The supplied report definition code was either missing or invalid, or the report definition was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
              example:
                errors:
                - id: ID of the error
                  code: parameterError
                  title: The report definition code passed was invalid
        '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
        '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
components:
  schemas:
    ErrorList:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          example: []
    ReportDefinitionList:
      type: object
      properties:
        meta:
          type: object
          properties:
            pagination:
              type: object
              properties:
                total:
                  type: integer
                isEstimatedTotal:
                  type: boolean
          example: example_value
        data:
          type: array
          items:
            $ref: '#/components/schemas/ReportDefinitionDTO'
          example: []
    Error:
      type: object
      properties:
        id:
          type: string
          example: abc123
        code:
          type: string
          example: example_value
        title:
          type: string
          example: Example Title
    ReportDefinitionDTO:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        code:
          type: string
          example: example_value
        releaseTag:
          type: string
          example: example_value
        entities:
          type: array
          items:
            $ref: '#/components/schemas/EntityDTO'
          example: []
    EntityDTO:
      type: object
      properties:
        entityId:
          type: integer
          format: int32
          example: '500123'
        name:
          type: string
          example: Example Title
        code:
          type: string
          example: example_value
  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