Factset Ofs API

openapi: 3.2.0
info:
  title: Factset Open:FactSet Marketplace Ofs API
  description: Headless CMS API used by the Open:FactSet Marketplace.
  contact:
    name: Open:FactSet Frontend Engineering Team
    email: openfactset-frontend-engineering@factset.com
  license:
    name: Proprietary
  version: v2.3.0
servers:
- url: https://api-sandbox.factset.com
security:
- Basic: []
tags:
- name: Ofs
paths:
  /ofs/v2/attributes/{id}:
    get:
      summary: Factset Retrieve a collection of Attribute records.
      parameters:
      - name: id
        in: path
        required: true
        description: Globally unique identifier (GUID) of an attribute record
        schema:
          example: 904eb623-2b58-4dba-8e81-61e2ef889bb5
      responses:
        '200':
          $ref: '#/components/schemas/GetAttributeDto'
        '404':
          description: Attribute record was not found.
      tags:
      - Ofs
  /ofs/v2/attributes:
    get:
      summary: Factset Retrieve a collection of Attribute records.
      parameters:
      - name: limit
        in: query
        description: Limit the amount of records per page
        schema:
          type: integer
          default: 10
      - name: page
        in: query
        description: Select which page to show
        schema:
          type: integer
          default: 1
          minimum: 1
      responses:
        '200':
          description: A JSON representation of collection of Attribute records. Might be empty.
          headers:
            X-Pagination:
              description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink)
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  allOf:
                  - $ref: '#/components/schemas/GetAttributeDto'
                type: array
        '422':
          description: Unprocessable entity. Validation error response containing the errors in a human readable form.
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
      tags:
      - Ofs
  /ofs/v2/attributes/search:
    post:
      summary: Factset Retrieve a collection of Attribute records.
      responses:
        '200':
          description: A JSON representation of collection of Attribute records. Might be empty.
          headers:
            X-Pagination:
              description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink)
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  allOf:
                  - $ref: '#/components/schemas/GetAttributeDto'
                type: array
        '422':
          description: Unprocessable entity. Validation error response containing the errors in a human readable form.
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
      tags:
      - Ofs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAttributeSearchDto'
  /ofs/v2/attributes/groups/{id}:
    get:
      summary: Factset Retrieve a specific Attributes Group record.
      parameters:
      - name: id
        in: path
        required: true
        description: Globally unique identifier (GUID) of an Attributes Group record
        schema:
          example: fd8f12e9-aa8b-4c2a-9e2e-a212f3ec29e1
      responses:
        '200':
          description: A JSON representation of an Attributes Group record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAttributesGroupDto'
        '404':
          description: Attributes Group record was not found.
      tags:
      - Ofs
  /ofs/v2/attributes/groups:
    get:
      summary: Factset Retrieve a collection of Attributes Group records.
      parameters:
      - name: limit
        in: query
        description: Limit the amount of records per page
        schema:
          type: integer
          default: 10
      - name: page
        in: query
        description: Select which page to show
        schema:
          type: integer
          default: 1
          minimum: 1
      responses:
        '200':
          description: A JSON representation of collection of Attributes Group records. Might be empty.
          headers:
            X-Pagination:
              description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink)
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  allOf:
                  - $ref: '#/components/schemas/GetAttributesGroupDto'
                type: array
        '422':
          description: Unprocessable entity. Validation error response containing the errors in a human readable form.
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
      tags:
      - Ofs
  /ofs/v2/attributes/groups/used:
    get:
      summary: Factset Retrieve a collection of Attributes Group records in use.
      parameters:
      - name: limit
        in: query
        description: Limit the amount of records per page
        schema:
          type: integer
          default: 10
      - name: page
        in: query
        description: Select which page to show
        schema:
          type: integer
          default: 1
          minimum: 1
      responses:
        '200':
          description: A JSON representation of collection of Attributes Group records. Might be empty.
          headers:
            X-Pagination:
              description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink)
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  allOf:
                  - $ref: '#/components/schemas/GetAttributesGroupDto'
                type: array
        '422':
          description: Unprocessable entity. Validation error response containing the errors in a human readable form.
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
      tags:
      - Ofs
  /ofs/v2/attributes/groups/search:
    post:
      summary: Factset Retrieve a collection of Attributes Group records.
      responses:
        '200':
          description: A JSON representation of collection of Attributes Group records. Might be empty.
          headers:
            X-Pagination:
              description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink)
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  allOf:
                  - $ref: '#/components/schemas/GetAttributesGroupDto'
                type: array
        '422':
          description: Unprocessable entity. Validation error response containing the errors in a human readable form.
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
      tags:
      - Ofs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAttributesGroupSearchDto'
  /ofs/v2/media/download/{namespace}/{scope}/{guid}/{fileName}:
    get:
      summary: Factset Retrieve a specific media file
      parameters:
      - name: namespace
        in: path
        required: true
        description: The namespace of the media file
        schema:
          example: partners
      - name: scope
        in: path
        required: true
        description: The scope of the media file
        schema:
          example: logo
      - name: guid
        in: path
        required: true
        description: The GUID of the file being requested
        schema:
          example: 774c3a5c-cc77-4e4c-b4a8-224a35cb00ba
      - name: fileName
        in: path
        required: true
        description: The name you want to show for this file in the uri.
        schema:
          example: FactSet.png
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
      tags:
      - Ofs
    head:
      summary: Factset Check the existence and retrieve the headers of a spefic media file
      parameters:
      - name: namespace
        in: path
        required: true
        description: The namespace of the media file
        schema:
          example: partners
      - name: scope
        in: path
        required: true
        description: The scope of the media file
        schema:
          example: logo
      - name: guid
        in: path
        required: true
        description: The GUID of the file being requested
        schema:
          example: 774c3a5c-cc77-4e4c-b4a8-224a35cb00ba
      - name: fileName
        in: path
        required: true
        description: The name you want to show for this file in the uri.
        schema:
          example: FactSet.png
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
      tags:
      - Ofs
  /ofs/v2/partners/{id}:
    get:
      summary: Factset Retrieve a specific Partner record.
      parameters:
      - name: id
        in: path
        required: true
        description: Globally unique identifier (GUID) of a partner record
        schema:
          example: caa0ee0f-c0fe-427e-9596-491e6c527b3f
      responses:
        '200':
          $ref: '#/components/schemas/GetPartnerDto'
        '404':
          description: Partner record was not found.
      tags:
      - Ofs
  /ofs/v2/partners:
    get:
      summary: Factset Retrieve a collection of Partner records.
      parameters:
      - name: limit
        in: query
        description: Limit the amount of records per page
        schema:
          type: integer
          default: 10
      - name: page
        in: query
        description: Select which page to show
        schema:
          type: integer
          default: 1
          minimum: 1
      responses:
        '200':
          description: A JSON representation of collection of Partner records. Might be empty.
          headers:
            X-Pagination:
              description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink)
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  allOf:
                  - $ref: '#/components/schemas/GetPartnerDto'
                type: array
        '422':
          description: Unprocessable entity. Validation error response containing the errors in a human readable form.
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
      tags:
      - Ofs
  /ofs/v2/partners/search:
    post:
      summary: Factset Retrieve a collection of Partner records.
      responses:
        '200':
          description: A JSON representation of collection of Partner records. Might be empty.
          headers:
            X-Pagination:
              description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink)
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  allOf:
                  - $ref: '#/components/schemas/GetPartnerDto'
                type: array
        '422':
          description: Unprocessable entity. Validation error response containing the errors in a human readable form.
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
      tags:
      - Ofs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostPartnerSearchDto'
  /ofs/v2/products/{id}:
    get:
      summary: Factset Retrieve a specific Product record.
      parameters:
      - name: id
        in: path
        required: true
        description: Globally unique identifier (GUID) of a Product record
        schema:
          example: 89bba0ab-b123-4766-8a7b-9a174a453571
      responses:
        '200':
          description: A JSON representation of a Product record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProductDto'
        '404':
          description: Product record was not found.
      tags:
      - Ofs
  /ofs/v2/products/types:
    get:
      summary: Factset Retrieve a collection of the available Product Types along with the number of published products per type.
      responses:
        '200':
          description: A JSON representation a collection of the available Product Types.
          content:
            application/json:
              schema:
                example:
                - type: Data Feed
                  total: 0
                - type: Solution
                  total: 0
                - type: API
                  total: 0
                items:
                  properties:
                    type:
                      type: string
                      enum:
                      - Data Feed
                      - API
                      - Solution
                    total:
                      type: integer
                  type: object
                type: array
      tags:
      - Ofs
  /ofs/v2/products:
    get:
      summary: Factset Retrieve a collection of Product records.
      parameters:
      - name: limit
        in: query
        description: Limit the amount of records per page
        schema:
          type: integer
          default: 10
      - name: page
        in: query
        description: Select which page to show
        schema:
          type: integer
          default: 1
          minimum: 1
      responses:
        '200':
          description: A JSON representation of collection of Product records. Might be empty.
          headers:
            X-Pagination:
              description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink)
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  allOf:
                  - $ref: '#/components/schemas/GetProductDto'
                type: array
        '422':
          description: Unprocessable entity. Validation error response containing the errors in a human readable form.
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
      tags:
      - Ofs
  /ofs/v2/products/search:
    post:
      summary: Factset Retrieve a collection of Product records.
      responses:
        '200':
          description: A JSON representation of collection of Product records. Might be empty.
          headers:
            X-Pagination:
              description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink)
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  allOf:
                  - $ref: '#/components/schemas/GetProductDto'
                type: array
        '422':
          description: Unprocessable entity. Validation error response containing the errors in a human readable form.
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
      tags:
      - Ofs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostProductSearchDto'
  /ofs/v2/resources/{id}:
    get:
      summary: Factset Retrieve a specific Resource record.
      parameters:
      - name: id
        in: path
        required: true
        description: Globally unique identifier (GUID) of a Resource record
        schema:
          example: 3d8410df-2b04-45fa-bc33-d2cc5418f293
      responses:
        '200':
          description: A JSON representation of an Resource record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetResourceDto'
        '404':
          description: Resource record was not found.
      tags:
      - Ofs
  /ofs/v2/resources:
    get:
      summary: Factset Retrieve a collection of Resource records.
      parameters:
      - name: limit
        in: query
        description: Limit the amount of records per page
        schema:
          type: integer
          default: 10
      - name: page
        in: query
        description: Select which page to show
        schema:
          type: integer
          default: 1
          minimum: 1
      responses:
        '200':
          description: A JSON representation of collection of Resource records. Might be empty.
          headers:
            X-Pagination:
              description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink)
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  allOf:
                  - $ref: '#/components/schemas/GetResourceDto'
                type: array
        '422':
          description: Unprocessable entity. Validation error response containing the errors in a human readable form.
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
      tags:
      - Ofs
  /ofs/v2/resources/search:
    post:
      summary: Factset Retrieve a collection of Resource records.
      responses:
        '200':
          description: A JSON representation of collection of Resource records. Might be empty.
          headers:
            X-Pagination:
              description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink)
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  allOf:
                  - $ref: '#/components/schemas/GetResourceDto'
                type: array
        '422':
          description: Unprocessable entity. Validation error response containing the errors in a human readable form.
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
      tags:
      - Ofs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostResourceSearchDto'
  /ofs/v2/resources/sections/{id}:
    get:
      summary: Factset Retrieve a specific Resources Section record.
      parameters:
      - name: id
        in: path
        required: true
        description: Globally unique identifier (GUID) of a Resources Section record
        schema:
          example: 4c77e650-372b-4ab4-9acd-bbd237d52b74
      responses:
        '200':
          description: A JSON representation of a Resources Section record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetResourcesSectionDto'
        '404':
          description: Resources Section record was not found.
      tags:
      - Ofs
  /ofs/v2/resources/sections:
    get:
      summary: Factset Retrieve a collection of Resources Section records.
      parameters:
      - name: limit
        in: query
        description: Limit the amount of records per page
        schema:
          type: integer
          default: 10
      - name: page
        in: query
        description: Select which page to show
        schema:
          type: integer
          default: 1
          minimum: 1
      responses:
        '200':
          description: A JSON representation of collection of Resources Section records. Might be empty.
          headers:
            X-Pagination:
              description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink)
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  allOf:
                  - $ref: '#/components/schemas/GetResourcesSectionDto'
                type: array
        '422':
          description: Unprocessable entity. Validation error response containing the errors in a human readable form.
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
      tags:
      - Ofs
  /ofs/v2/resources/sections/search:
    post:
      summary: Factset Retrieve a collection of Resources Section records.
      responses:
        '200':
          description: A JSON representation of collection of Resources Section records. Might be empty.
          headers:
            X-Pagination:
              description: A JSON containing pagination information. (e.g totalCount,pageSize,currentPage,totalPages,previousPageLink and nextPageLink)
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  allOf:
                  - $ref: '#/components/schemas/GetResourcesSectionDto'
                type: array
        '422':
          description: Unprocessable entity. Validation error response containing the errors in a human readable form.
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
      tags:
      - Ofs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostResourcesSectionSearchDto'
components:
  schemas:
    GetResourcesSectionDto:
      description: A Json representation of a Document Category record.
      properties:
        id:
          example: 4c77e650-372b-4ab4-9acd-bbd237d52b74
          type: string
        name:
          example: New Provider Resources
          type: string
        order:
          example: 3
          type: integer
        created:
          example: 1559578671
          type: integer
        updated:
          example: 1559578671
          type: integer
        documents:
          example:
            id: 3d8410df-2b04-45fa-bc33-d2cc5418f293
            name: Candidate Agreement--Exhibit A
            fileName: Exhibit A.docx
            description: Template for Exhibit A to the new Candidate Agreement. Fill out this document with a description of the product(s) for the Open=>FactSet marketplace
            url: /media/download/resources/documents/c2e2394c-747e-422f-bc5d-b775b14833bd
            order: 5
            isFile: true
            isPublic: true
            categoryId: 4c77e650-372b-4ab4-9acd-bbd237d52b74
            created: 1564487399
            updated: 1568288463
          items:
            $ref: '#/components/schemas/GetResourceDto'
          type: array
        meta:
          example:
            documentsTotal: 1
            documentsPrivate: 0
          items:
            properties:
              documentsTotal:
                type: integer
              documentsPrivate:
                type: integer
            type: object
          type: array
      type: object
    PostResourceSearchDto:
      properties:
        limit:
          description: Limit the amount of records per page.
          example: 10
          type: integer
          default: 10
          maximum: 300
        page:
          description: Select which page to show.
          example: 1
          type: integer
          default: 1
          minimum: 1
        sort:
          description: Sort according to  specific field value.
          example: name:desc
          type: string
          default: name:asc
        fields:
          description: Fetch only specific fields. The fields' names separated by a comma.
          example: name,fileName,isPublic,url
          type: string
        search:
          description: Search for terms in certain fields.
          example: description:Template,name:Template,fileName:Template
          type: string
        filter:
          description: Filter against specific field values.
          example: isFile:true
          type: string
      type: object
    PostPartnerSearchDto:
      properties:
        limit:
          description: Limit the amount of records per page.
          example: 10
          type: integer
          default: 10
          maximum: 300
        page:
          description: Select which page to show.
          example: 1
          type: integer
          default: 1
          minimum: 1
        sort:
          description: Sort according to  specific field value.
          example: name:asc
          type: string
          default: name:asc
        fields:
          description: Fetch only specific fields. The fields' names separated by a comma.
          example: name,marking.state,slug
          type: string
        search:
          description: Search for terms in certain fields.
          example: name:FactSet
          type: string
        filter:
          description: Filter against specific field values.
          example: name:FactSet
          type: string
      type: object
    Document:
      properties:
        name:
          type: string
        description:
          type: string
        fileName:
          type: string
        url:
          type: string
        isFile:
          type: boolean
        isPublic:
          type: boolean
        order:
          type: integer
        section:
          items:
            properties:
              id:
                type: integer
              name:
                type: string
            type: object
          type: array
      type: object
    Marking:
      properties:
        state:
          example: published
          type: string
      type: object
    GetPartnerDto:
      description: A Json representation of a Partner record.
      properties:
        id:
          example: caa0ee0f-c0fe-427e-9596-491e6c527b3f
          type: string
        logoUrl:
          example: /media/download/partners/logo/774c3a5c-cc77-4e4c-b4a8-224a35cb00ba
          type: string
        forumTags:
          example:
          - id: factset
            tag: factset
          items:
            properties:
              tag:
                type: string
              id:
                type: string
            type: object
          type: array
        videoUrl:
          example: https://vimeo.com/320509757
          type: string
        firmInfo:
          example: FactSet creates data and technology solutions for investment professionals around the world, providing instant access to financial data and analytics that investors use to make crucial decisions. We combine our unique proprietary datasets, your in-house data, and third-party unstructured data to help you see and seize opportunity sooner.\n
          type: string
        socialMedia:
          example:
            linkedin: https://www.linkedin.com/company/factset
            twitter: https://twitter.com/FactSet
            facebook: https://www.facebook.com/FactSet/
          properties:
            linkedin:
              type: string
            facebook:
              type: string
            twitter:
              type: string
          type: object
        name:
          example: FactSet
          type: string
        firmId:
          example: 6992
          type: integer
        companyUrl:
          example: https://www.factset.com/
          type: string
        seoMeta:
          example:
            partnerTitle: FactSet
            partnerSummary: FactSet creates data and technology solutions for investment professionals around the world.
            videoAltText: ''
          properties:
            productTitle:
              type: string
            productSummary:
              type: string
          type: object
        publishedDate:
          example: 1568801114
          type: integer
        slug:
          example: factset
          type: string
        marking:
          $ref: '#/components/schemas/Marking'
        created:
          example: 1518816584
          type: integer
        updated:
          example: 1568801114
          type: integer
        versionSchema:
          example:
            major: 1
            minor: 0
            patch: 0
            versionedId: caa0ee0f-c0fe-427e-9596-491e6c527b3f-1.0.0
            originalId: caa0ee0f-c0fe-427e-9596-491e6c527b3f
          properties:
            major:
              type: integer
            minor:
              type: integer
            patch:
              type: integer
            versionedId:
              type: string
            originalId:
              type: string
          type: object
      type: object
    GetProductDto:
      description: A Json representation of a Product record.
      properties:
        id:
          example: 89bba0ab-b123-4766-8a7b-9a174a453571
          type: string
        marking:
          $ref: '#/components/schemas/Marking'
        name:
          example: FactSet Corporate Governance
          type: string
        detail:
          example: 'FactSet’s corporate activism database, SharkRepellent, allows you to monitor and analyze corporate activism with data items related to poison pills, significant activism reported in SEC filings and news sources, and key takeover defenses compiled from articles of incorporation, bylaws, and other publicly available sources.  Data Frequency:  Event;  Update Frequency:  Intraday. '
          type: string
        dateAdded:
          example: 1441029240
          type: integer
        highlight:
          example:
            point1: Access activism campaign details, including participants, events, defenses, filing dates, and related entities
            point2: Leverage takeover defense and corporate governance data, including bullet proof ratings, charter provisions and amendment details, and appeal/repeal percentage requirements
            point3: Obtain data for all U.S. in-force poison pills, Canadian in-force and ratification pending poison pills, and any other non-U.S. EDGAR filers that adopts a U.S. style poison pill
          properties:
            point1:
              type: string
            point2:
              type: string
            point3:
              type: string
          type: object
        coverageTable:
          example:
            columns:
            - field: field1
              title: region
              align: left
              required: true
            - field: field2
              title: Count
              align: left
              required: true
            - field: field3
              title: Type
              align: left
              required: false
            - field: field4
              title: Start Date
              align: left
              required: false
            rows:
            - field1: Africa
              field3: Entities
              field2: '{40}'
              field4: '2014'
            - field1: Asi

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/factset/refs/heads/main/openapi/factset-ofs-api-openapi.yml