openapi: 3.0.0
info:
  version: 2.8.0
  title: FactSet Concordance API
  description: >2


    The FactSet Concordance API enables Application Developers and Data
    Scientists to programmatically discover the FactSet Identifier for a
    specific Entity or Person based on attributes, such as name, URL, and
    location.FactSet Identifiers are mapped to industry-standard identifiers, as
    well as to a comprehensive set of reference data and unique content, to
    enhance the ability to quickly connect content sets.<p>  

     Using the submitted attributes, the FactSet Concordance API leverages FactSet’s extensive Entity Master, People, and Symbology databases to return potential candidate matches and a proposed match. The result is a concorded FactSet Identifier that can then be used as input throughout FactSet's expanding catalog of Content using our Content APIs or Standard DataFeeds.</p>
     
     <b>There are two types of workflows supported in the API:</b>
     
     <b>Entity & People Match:</b> The first workflow follows traditional API conventions in that a request is accepted and a response is returned synchronously enabling the concordance of up to 25 names in a single request. The response returns a list of 20 candidates as well as a proposed match.
     
     <b>Entity & People Match - Bulk:</b> The second workflow allows you to input a large list of names within a .CSV file in a single request With this workflow, a task is created for uploading a set of queries. Once the task has completed, the client retrieves the concordance results through the /entity-decisions or /people-decisions endpoint. Note that in the Bulk workflow, only the matches for the records are returned. Candidates are not included.
     
     Once the service has provided a list of concorded FactSet Identifiers, you can then use our Entity Mappings and People Mappings endpoints to further review the universe of mapped identifiers or modify existing records. </p>
     
  contact:
    name: FactSet Research Systems, Inc.
    email: api@factset.com
servers:
  - url: https://api.factset.com/content
    description: Production Server
security:
  - UserSecurity: []
tags:
  - name: Factset Concordance
paths:
  /factset-concordance/v2/entity-match:
    get:
      summary: Factset Get Entity Candidates and Matches for a single name and attributes.
      description: >
        Finds the best candidate entities matching the given entity name.
        Additional attributes can be supplied to narrow the search, such as
        State, URL, and Entity Types. <p>**Max of 1 Name permitted in a single
        GET request.** Use the POST method for /entity-match to fetch up to 25
        names. Otherwise, use the "Entity Match - Bulk" workflow to submit
        larger universes of names to be concorded via a file.</p><p>
      tags:
        - Factset Concordance
      operationId: getEntityMatch
      parameters:
        - $ref: '#/components/parameters/name'
        - $ref: '#/components/parameters/country'
        - $ref: '#/components/parameters/state'
        - $ref: '#/components/parameters/url'
        - $ref: '#/components/parameters/includeEntityType'
        - $ref: '#/components/parameters/excludeEntityType'
        - $ref: '#/components/parameters/includeEntitySubType'
        - $ref: '#/components/parameters/excludeEntitySubType'
        - $ref: '#/components/parameters/addParent'
        - $ref: '#/components/parameters/bbgFigi'
        - $ref: '#/components/parameters/bbgTicker'
        - $ref: '#/components/parameters/bic'
        - $ref: '#/components/parameters/cik'
        - $ref: '#/components/parameters/crd'
        - $ref: '#/components/parameters/cusip'
        - $ref: '#/components/parameters/duns'
        - $ref: '#/components/parameters/ein'
        - $ref: '#/components/parameters/factsetId'
        - $ref: '#/components/parameters/fitch'
        - $ref: '#/components/parameters/gvkey'
        - $ref: '#/components/parameters/gvkeyIid'
        - $ref: '#/components/parameters/isin'
        - $ref: '#/components/parameters/jcn'
        - $ref: '#/components/parameters/lei'
        - $ref: '#/components/parameters/lxid'
        - $ref: '#/components/parameters/md'
        - $ref: '#/components/parameters/redCode'
        - $ref: '#/components/parameters/rssd'
        - $ref: '#/components/parameters/sedol'
        - $ref: '#/components/parameters/spr'
        - $ref: '#/components/parameters/ticker'
        - $ref: '#/components/parameters/tickerExchange'
        - $ref: '#/components/parameters/tickerRegion'
        - $ref: '#/components/parameters/ukch'
        - $ref: '#/components/parameters/valoren'
        - $ref: '#/components/parameters/wkn'
      responses:
        '200':
          $ref: '#/components/responses/EntityMatchResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
    post:
      summary: >-
        Factset Get a list of Entity Candidates and Matches for a requested list of up to 25 names and attributes.
      description: >
        Finds the best candidate entities matching the given entity name. If a
        `universeId` is provided, any match for an input including a `clientId`
        will be saved to that universe. Additional attributes can be supplied to
        narrow the search, such as State, URL, and Entity Types. Finds the best
        candidate entities matching the given company name. Additional
        attributes can be supplied to narrow the search.  <p>**Max of 25 Names
        inputted.** Use the "Entity Match - Bulk" workflow to submit larger
        universes of names to be concorded via a file.</p><p> Supported types of
        Entities in which the names can match to include -
          * Corporations, Joint Ventures, and Holding Companies
          * Fund Managers and various Fund Types (Open-end, Closed End, Hedge, Soverign Wealth, Pension, Exchange Traded, and more).</p>
      tags:
        - Factset Concordance
      operationId: getEntityMatchForList
      requestBody:
        $ref: '#/components/requestBodies/EntityMatchRequestV2'
      responses:
        '200':
          $ref: '#/components/responses/EntityMatchResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
  /factset-concordance/v2/entity-task:
    post:
      summary: Factset Input a file with names and attributes, creating a taskId.
      description: >
        Upload a Comma-Separated List file (.csv / UTF-8 encoding) with a list
        of names and attributes and receive a `taskId`. The taskId is then used
        for reference in the */entity-task-status* and */entity-decisions*
        endpoints to receive results once the task is successful.<p>This is the
        first step in the overall "Bulk" workflow. Use the /entity-task-status
        endpoint to check the status.</p> <p> A universeId must be included in
        request. If you do not have a universe created, reference the
        `/universe` endpoint.
      tags:
        - Factset Concordance
      operationId: getEntityTaskForList
      requestBody:
        description: Entity Request object. Used to create an Entity Task.
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                universeId:
                  description: >-
                    The id of the universe that entities should be mapped to.
                    Reference the `/universe` endpoint to create a universe, or
                    view available universes via `/universes`.
                  type: integer
                  example: 1
                taskName:
                  description: >-
                    User defined name for the task that will be used to name the
                    output files.
                  type: string
                  example: test31
                inputFile:
                  description: >
                    The UTF-8 encoded CSV File containing the entity names to be
                    concorded to a FactSet Entity Identifier. The files first
                    row **MUST** include headers as defined in the *Column
                    parameters. Be mindful of casing and spacing in column
                    headers. The input file is posted as a file object in the
                    form. For this reason, the mime type of this post request
                    must be multipart/form-data.
                  type: string
                  format: binary
                  example: Name,Country\nFactSet,US\n
                clientIdColumn:
                  description: >
                    Header Name of the column in the input file that contains a
                    unique identifier supplied by the user referred to as a
                    "clientId". This clientId can be used to create custom
                    mappings or references.
                  type: string
                  example: ClientId
                nameColumn:
                  description: >
                    Header name of the column in the input file that contains
                    the Entity Name to be matched.
                  type: string
                  example: NAME
                countryColumn:
                  description: >
                    Header Name of the column in the input file that contains
                    the country's ISO Code. This is used to filter the
                    candidates before taking a match decision.
                  type: string
                  example: COUNTRY
                urlColumn:
                  description: >
                    Header Name of the column in the input file that contains
                    the Entity's URL. URL corresponding to the entity name that
                    is used when evaluating candidates for a match.
                  type: string
                  example: URL
                stateColumn:
                  description: >
                    Header Name of the column in the input file that contains
                    the two letter State Code of the state or province where the
                    Entity is located. Currently, only US state codes are
                    supported.
                  type: string
                  example: STATE
                priorityColumn:
                  description: >
                    Header Name of the column in the inputfile that contains the
                    priority for the client id.
                  type: string
                  example: Priority
                bbgFigiColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    `Bloomberg Listing/Regional/Security ID`.
                  type: string
                  example: BloombergId
                bbgTickerColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    Bloomberg `Listing and Regional Ticker`.
                  type: string
                  example: BloombergTicker
                bicColumn:
                  description: >
                    Header Name of the column in the input file for the type
                    BICCode, `bank indentification code`.
                  type: string
                  example: BICCode
                cikColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    CIK, `Edgar Central Index Keys`
                  type: string
                  example: CIK
                crdColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    CRD, `Central Registration Depository`.
                  type: string
                  example: CRD
                cusipColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    `CUSIP`
                  type: string
                  example: CUSIP
                dunsColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    DUNS, `Dun&Bradstreet`.
                  type: string
                  example: Dun&Bradstreet
                einColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    EIN, `EmployerIdentificationNumber`.
                  type: string
                  example: EmployerIdentificationNumber
                factsetIdColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    FactSet Identifier - `FactSet -E,-S,-R, -L Permanent
                    Identifier`.
                  type: string
                  example: FactSetIdentifier
                fitchColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    FitchCreditRating, `Fitch Ratings Identifier`.
                  type: string
                  example: FitchCreditRating
                gvkeyColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    GVKEY - `Compustat Global Company Key`.
                  type: string
                  example: GVKey
                gvkeyIidColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    GVKEY+IID - `Compustat Global Company Key and Issue
                    Identifier`.
                  type: string
                  example: GVKeyIssueIdentifier
                isinColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    `ISIN`.
                  type: string
                  example: ISIN
                jcnColumn:
                  description: >-
                    Header Name of the column in the input file for the type JCN
                    - `Japanese Corporate Number`.
                  type: string
                  example: JCN
                leiColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    LEI, `LegalEntityIdentifier`.
                  type: string
                  example: LegalEntityIdentifier
                lxidColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    LXID - `Markit Syndicated Loan Identifier`.
                  type: string
                  example: LXID
                mdColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    MoodysIssuer, `Moody's Ratings Identifier`.
                  type: string
                  example: MoodysIssuer
                redCodeColumn:
                  description: >-
                    Header Name of the column in the input file for the type Red
                    Code - `Markit Reference Entity Identifier`.
                  type: string
                  example: RedCode
                rssdColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    RSSD, `FederalReserveRSSDIdentifier`.
                  type: string
                  example: FederalReserveRSSDIdentifier
                sedolColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    `SEDOL`.
                  type: string
                  example: SEDOL
                sprColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    S&PRating, `S&P Ratings Identifier`.
                  type: string
                  example: SPRating
                tickerColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    `PriceTicker`.
                  type: string
                  example: PriceTicker
                tickerExchangeColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    `TickerExchange`.
                  type: string
                  example: TickerExch
                tickerRegionColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    `TickerRegion`.
                  type: string
                  example: TickerRegion
                ukchColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    `UKCompanyHouse`.
                  type: string
                  example: UKCompanyHouse
                valorenColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    VALOR, `Valoren ("Valor") Identification`.
                  type: string
                  example: VALOR
                wknColumn:
                  description: >-
                    Header Name of the column in the input file for the type
                    WKN, `German Securities Identification`.
                  type: string
                  example: WKN
                includeEntityType:
                  description: >
                    Three-character FactSet entity type code used to filter
                    candidates in order to determine the final match result.
                    Only candidates with an entity type specified will be
                    considered for the final match result. Multiple types can be
                    entered separated by commas. **Do not include within
                    `inputFile`.**
                  type: array
                  items:
                    type: string
                    example: PUB
                    maxLength: 3
                    minLength: 3
                excludeEntityType:
                  description: >
                    Three-character FactSet entity type code used to filter
                    candidates in order to determine the final match result.
                    Entities with these types will be excluded from the
                    decisions.

                    It is a global option used to filter the candidates before
                    taking a match decision.

                    Candidates with an entity type specified will *not* be
                    considered for the final match result.

                    **Do not include within `inputFile`.**
                  type: array
                  items:
                    type: string
                    example: EXT
                    maxLength: 3
                    minLength: 3
                includeEntitySubType:
                  description: >
                    Two-character FactSet entity subtype code used to filter
                    candidates in order to determine the final match result.
                    Only candidates with an entity subtype specified will be
                    considered for the final match result. Multiple types can be
                    entered separated by commas. **Do not include within
                    `inputFile`.**
                  type: array
                  items:
                    type: string
                    example: PR
                    maxLength: 2
                    minLength: 2
                excludeEntitySubType:
                  description: >
                    Two-character FactSet entity subtype code used to filter
                    candidates in order to determine the final match result.
                    Candidates with an entity subtype specified will *not* be
                    considered for the final match result. Multiple types can be
                    entered separated by commas.

                    **Do not include within `inputFile`.**
                  type: array
                  items:
                    type: string
                    example: IB
                    maxLength: 2
                    minLength: 2
                additionalContextColumns:
                  description: >
                    Comma separated list of any additional column names in the
                    input file.  To be used by Managed Service for any unmapped
                    records.
                  type: array
                  maxItems: 5
                  items:
                    type: string
                    example: Address
              required:
                - universeId
                - taskName
                - inputFile
                - nameColumn
                - clientIdColumn
      responses:
        '200':
          $ref: '#/components/responses/EntityTaskResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
  /factset-concordance/v2/entity-task-status:
    get:
      summary: Factset Gets the status of the requested taskId or all tasks for a User
      description: >
        Pulls the **status** for ALL the Entity Tasks submitted by a client
        within the last 30 days, and related details such as task duration and
        decision rates. Specific Tasks can also be retrieved by using the
        _taskId_ parameter.<p>Status types include -
          * PENDING - The task has not yet started.
          * IN_PROGRESS - The task is submitted and decisions are in progress.
          * SUCCESS - The task was successful! Move to the /entity-decisions endpoint to retrieve decisions.
          * FAILURE - The task failed. Reach out to FactSet Support for assistance.
          * BAD_REQUEST - The task creation was unsuccesfull. Typically occurs with an incorrect input file format or column headers.
          * ABORTED - The task was aborted.
      tags:
        - Factset Concordance
      operationId: getEntityTaskStatus
      parameters:
        - $ref: '#/components/parameters/taskStatusId'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/status'
      responses:
        '200':
          $ref: '#/components/responses/EntityTaskStatusResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
  /factset-concordance/v2/entity-decisions:
    get:
      summary: Factset Get the decisions of matches for the requested taskId.
      description: >
        Retrieves the `Decision` objects for an Entity Task (taskId). The
        decisions do not include all candidates, but rather the results of
        concording the requested list of names included in the input file.
        Mapped entities will include a FactSet Entity Identifier (-E). Results
        will be saved to the `universeId` specified in the input file.
      tags:
        - Factset Concordance
      operationId: getEntityDecisions
      parameters:
        - $ref: '#/components/parameters/taskDecisionId'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
      responses:
        '200':
          $ref: '#/components/responses/EntityDecisionsResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
  /factset-concordance/v2/universe:
    post:
      summary: Factset Create a new universe
      description: |
        Create a new universe that is distinct from any existing universe
      tags:
        - Factset Concordance
      operationId: getUniverseForList
      requestBody:
        $ref: '#/components/requestBodies/CreateUniverseRequest'
      responses:
        '200':
          $ref: '#/components/responses/UniverseMetaResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/errorResponse'
  /factset-concordance/v2/entity-universe:
    get:
      summary: Factset Retrieve all saved mappings within a requested universe
      description: |
        Retrieves all entity mappings within a requested universe.
      tags:
        - Factset Concordance
      operationId: getEntityUniverse
      parameters:
        - $ref: '#/components/parameters/universeIdRequired'
        - $ref: '#/components/parameters/clientIdFilter'
        - $ref: '#/components/parameters/mapStatus'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/sortEntity'
      responses:
        '200':
          $ref: '#/components/responses/EntityUniverseResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
    post:
      summary: >-
        Factset Retrieve all saved mappings within a requested universe or large list of client ids
      description: >
        Retrieves all entity mappings that were saved in a given universe.
        Supports filtering by a large number of `clientId`s
      tags:
        - Factset Concordance
      operationId: getEntityUniverseForList
      requestBody:
        $ref: '#/components/requestBodies/EntityUniverseRequest'
      responses:
        '200':
          $ref: '#/components/responses/EntityUniverseResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
  /factset-concordance/v2/people-universe:
    get:
      summary: Factset Retrieve all saved mappings within a requested universe
      description: |
        Retrieves all people mappings within a requested universe.
      tags:
        - Factset Concordance
      operationId: getPeopleUniverse
      parameters:
        - $ref: '#/components/parameters/universeIdRequired'
        - $ref: '#/components/parameters/clientId'
        - $ref: '#/components/parameters/mapStatus'
        - $ref: '#/components/parameters/peopleOffset'
        - $ref: '#/components/parameters/peopleLimit'
        - $ref: '#/components/parameters/sortPeople'
      responses:
        '200':
          $ref: '#/components/responses/PeopleUniverseResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
    post:
      summary: >-
        Factset Retrieve all saved mappings within a requested universe or large list of client ids
      description: >
        Retrieves all people mappings that were saved in a given universe.
        Supports filtering by a large number of `clientId`s
      tags:
        - Factset Concordance
      operationId: getPeopleUniverseForList
      requestBody:
        $ref: '#/components/requestBodies/PeopleUniverseRequest'
      responses:
        '200':
          $ref: '#/components/responses/PeopleUniverseResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
  /factset-concordance/v2/update-universe:
    post:
      summary: Factset Update metadata for an existing universe
      description: |
        Update metadata for an existing universe
      tags:
        - Factset Concordance
      operationId: getUpdateUniverseForList
      requestBody:
        $ref: '#/components/requestBodies/UpdateUniverseRequest'
      responses:
        '200':
          $ref: '#/components/responses/UniverseMetaResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/errorResponse'
  /factset-concordance/v2/universes:
    get:
      summary: Factset Fetch metadata for universes
      description: >
        Fetch information on active universes for the current user. Optionally
        filter for a specific universe given a `universeId`
      tags:
        - Factset Concordance
      operationId: getUniverses
      parameters:
        - $ref: '#/components/parameters/universeId'
        - $ref: '#/components/parameters/universeType'
      responses:
        '200':
          $ref: '#/components/responses/UniversesResponse'
        default:
          $ref: '#/components/responses/errorResponse'
  /factset-concordance/v2/entity-universe-statistics:
    get:
      summary: Factset Get statistics on a given universe
      description: >
        Get the total number of mappings in a universe, as well as the number of
        mapped, unmapped and indeterminate mappings
      tags:
        - Factset Concordance
      operationId: getEntityUniverseStatistics
      parameters:
        - $ref: '#/components/parameters/universeIdRequired'
      responses:
        '200':
          $ref: '#/components/responses/EntityUniverseStatisticsResponse'
        default:
          $ref: '#/components/responses/errorResponse'
  /factset-concordance/v2/universe-statistics:
    get:
      summary: Factset Get statistics on a given universe
      description: >
        Get the total number of mappings in a universe, as well as the number of
        mapped, unmapped and indeterminate mappings
      tags:
        - Factset Concordance
      operationId: getUniverseStatistics
      parameters:
        - $ref: '#/components/parameters/universeStatisticsRequired'
      responses:
        '200':
          $ref: '#/components/responses/universeStatisticsResponse'
        default:
          $ref: '#/components/responses/errorResponse'
  /factset-concordance/v2/entity-mapping:
    post:
      summary: Factset Saves a single-mapping specified by the client.
      description: >
        Saves a Concordance Mapping to the client universe. When making a post,
        all exiting values are overwritten in the database with the values
        passed in the request. clientId and clientName are required.
      tags:
        - Factset Concordance
      operationId: getEntityMappingForList
      requestBody:
        $ref: '#/components/requestBodies/EntityMappingRequestV2'
      responses:
        '200':
          $ref: '#/components/responses/EntityResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
  /factset-concordance/v2/people-mapping:
    post:
      summary: Factset Saves a single-mapping specified by the client.
      description: >
        Saves a single Concordance People Mapping to a given universe. When
        making a post, all exiting values are overwritten in the database with
        the values passed in the request. clientId and clientName are required.
      tags:
        - Factset Concordance
      operationId: getPeopleMappingForList
      requestBody:
        $ref: '#/components/requestBodies/PeopleMappingRequestV2'
      responses:
        '200':
          $ref: '#/components/responses/PeopleMappingResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
  /factset-concordance/v2/entity-mapping-delete:
    post:
      summary: Factset Deletes mapping specified by the client.
      description: >
        Delete a Concordance Mapping to the client universe. When making a post,
        all exiting values are overwritten in the database with the values
        passed in the request. clientId and universeId are required.
      tags:
        - Factset Concordance
      operationId: getEntityMappingDeleteForList
      requestBody:
        $ref: '#/components/requestBodies/EntityMappingDeleteRequestV2'
      responses:
        '200':
          $ref: '#/components/responses/EntityMappingDeleteResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
  /factset-concordance/v2/people-mapping-delete:
    post:
      summary: Factset Deletes mapping specified by the client.
      description: >
        Delete a Concordance Mapping to the client universe. When making a post,
        all exiting values are overwritten in the database with the values
        passed in the request. clientId and universeId are required.
      tags:
        - Factset Concordance
      operationId: getPeopleMappingDeleteForList
      requestBody:
        $ref: '#/components/requestBodies/PeopleMappingDeleteRequestV2'
      responses:
        '200':
          $ref: '#/components/responses/PeopleMappingDeleteResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
  /factset-concordance/v2/snowflake-entity-match:
    post:
      summary: >-
        Factset Perform an entity search and return a snowflake-friendly response. Up to 25 Names per request.
      description: >
        Finds the best candidate entities matching the given company name.
        Additional attributes can be supplied to narrow the search. *This
        endpoint is used natively within Snowflake and is not to be consumed
        directly by users. Reach out to your FactSet Account team to learn more
        about Concordance in Snowflake.*
      tags:
        - Factset Concordance
      operationId: getSnowflakeEntityMatchForList
      requestBody:
        $ref: '#/components/requestBodies/SnowflakeEntityMatchRequest'
      responses:
        '200':
          $ref: '#/components/responses/SnowflakeEntityMatchResponse'
  /factset-concordance/v2/snowflake-entity-mapping:
    post:
      summary: Factset Save entity mappings to a universe
      description: Manually save or update entity mappings with metadata
      tags:
        - Factset Concordance
      operationId: snowflakeEntityMappingPost
      requestBody:
        $ref: '#/components/requestBodies/SnowflakeEntityMappingRequest'
      responses:
        default:
          $ref: '#/components/responses/SnowflakeEntityMappingResponse'
  /factset-concordance/v2/people-match:
    get:
      summary: >-
        Factset Find potential people matches given a person's name.People matches can be retrieved using person's name and other attributes like firstname, middlename and lastname.
      description: >
        Finds the best people candidates matching the given name. <p>**Max of 1
        Name permitted in a single GET request.** Use the POST method for
        /people-match to fetch up to 25 names. Otherwise, use the "People Match
        - Bulk" workflow to submit larger universes of names to be concorded via
        a file.</p><p>
      tags:
        - Factset Concordance
      operationId: getPeopleMatch
      parameters:
        - $ref: '#/components/parameters/personName'
        - $ref: '#/components/parameters/salutation'
        - $ref: '#/components/parameters/firstName'
        - $ref: '#/components/parameters/middleName'
        - $ref: '#/components/parameters/lastName'
        - $ref: '#/components/parameters/suffix'
        - $ref: '#/components/parameters/entity'
      responses:
        '200':
          $ref: '#/components/responses/PeopleMatchResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
    post:
      summary: Factset Find potential people matches given a person's name.
      description: >
        Finds the best candidate people matching the given people names.
        Additional attributes can be supplied to narrow the search. If a
        `universeId` is provided, any match for an input including a `clientId`
        will be saved to that universe.
      tags:
        - Factset Concordance
      operationId: getPeopleMatchForList
      requestBody:
        $ref: '#/components/requestBodies/PeopleMatchRequestV2'
      responses:
        '200':
          $ref: '#/components/responses/PeopleMatchResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
  /factset-concordance/v2/people-task:
    post:
      summary: Factset Create a People Concordance Task.
      description: >
        The "Bulk" workflow allows the user to create a People Concordance Task.
        Uploading of a Comma-Separated List file (.csv / UTF-8 encoding) with a
        list of names and attributes and creation of a task id is mandatory to
        start the process.
           The taskId is then used for reference in the /people-task-status and /people-decisions endpoints to receive results once the task is successful.The /people-task-status endpoint is to check the status of the Tasks as per the ids.
            A universeId must be included in request. If you do not have a universe created, reference the /universe endpoint.The bulk workflow supports a two way approach for the user.
          **The user can use these parameters in the following ways.**
            1.Filling all the required fields including the `personNameColumn`.(do not include `firstNameColumn`,`lastNameColumn` & `middleNameColumn`)
            2.Filling all the required fields excluding the `personNameColumn`.(Ensure atleast the `lastNameColumn` is filled)
      tags:
        - Factset Concordance
      operationId: getPeopleTaskForList
      requestBody:
        description: People Request object. Used to create an People Task.
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                universeId:
                  description: >-
                    The id of the universe that entities should be mapped to.
                    Reference the `/universe` endpoint to create a universe, or
                    view available universes via `/universes`.
                  type: integer
                  example: 1
                taskName:
                  description: >-
                    User defined name for the task that will be used to name the
                    output files.
                  type: string
                  example: test31
                inputFile:
                  description: >
                    The UTF-8 encoded CSV File containing the entity names to be
                    concorded to a FactSet Entity Identifier. The files first
                    row **MUST** include headers as defined in the *Column
                    parameters. Be mindful of casing and spacing in column
                    headers. The input file is posted as a file object in the
                    form. For this reason, the mime type of this post request
                    must be multipart/form-data.
                  type: string
                  format: binary
                  example: Name,Country\nFactSet,US\n
                clientIdColumn:
                  description: >
                    Header Name of the column in the input file that contains a
                    unique identifier supplied by the user referred to as a
                    "clientId". This clientId can be used to create custom
                    mappings or references.
                  type: string
                  example: ClientId
                additionalContextColumns:
                  description: >
                    Comma separated list of any additional column names in the
                    input file.  To be used by Managed Service for any unmapped
                    records.
                  type: array
                  maxItems: 5
                  items:
                    type: string
                    example: Address
                entityColumn:
                  description: >
                    Header name of the column in the input file that contains
                    the Entity Name to be matched.
                  type: string
                  example: Microsoft
                firstNameColumn:
                  description: >
                    First name of the person.**Do not include with
                    `personNameColumn`**. 
                  type: string
                  example: Bill
                lastNameColumn:
                  description: >
                    Lat name of the person.**Do not include with
                    `personNameColumn`**.
                  type: string
                  example: Gates
                middleNameColumn:
                  description: >
                    Middle name of the person.**Do not include within
                    `personNameColumn`**.
                  type: string
                  example: Henry
                personNameColumn:
                  description: >
                    Header name of the column in the input file that contains
                    the name of the person to be matched. **Do not include with
                    `firstNameColumn` and `lastNameColumn`.**
                  type: string
                  example: Bill Gates
                priorityColumn:
                  description: >
                    Priority associated to the clientId. Used for manual
                    mapping.
                  type: string
                  example: HIGH
                salutationColumn:
                  description: >
                    The salutation of the person.**Do not include with
                    `personNameColumn`**.
                  type: string
                  example: Mr.
                suffixColumn:
                  description: >
                    A name suffix, that follows a person's full name and
                    provides additional information about the person.**Do not
                    include with `personNameColumn`**.
                  type: string
                  example: HIGH
              required:
                - universeId
                - taskName
                - inputFile
                - entityColumn
                - clientIdColumn
      responses:
        '200':
          $ref: '#/components/responses/PeopleTaskResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
  /factset-concordance/v2/people-task-status:
    get:
      summary: Factset Get the Status of the People Tasks.
      description: >
        Pulls the **status** for ALL the People Tasks submitted by a client
        within the last 30 days, and related details such as task duration and
        decision rates. Specific Tasks can also be retrieved by using the
        _taskId_ parameter.<p>Status types include -
          * PENDING - The task has not yet started.
          * IN_PROGRESS - The task is submitted and decisions are in progress.
          * SUCCESS - The task was successful! Move to the /people-decisions endpoint to retrieve decisions.
          * FAILURE - The task failed. Reach out to FactSet Support for assistance.
          * BAD_REQUEST - The task creation was unsuccesfull. Typically occurs with an incorrect input file format or column headers.
          * ABORTED - The task was aborted.
      tags:
        - Factset Concordance
      operationId: getPeopleTaskStatus
      parameters:
        - $ref: '#/components/parameters/peopleTaskStatusId'
        - $ref: '#/components/parameters/peopleOffset'
        - $ref: '#/components/parameters/peopleLimit'
        - $ref: '#/components/parameters/peopleStatus'
      responses:
        '200':
          $ref: '#/components/responses/PeopleTaskStatusResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
  /factset-concordance/v2/people-decisions:
    get:
      summary: Factset Get the decisions of matches for the requested taskId.
      description: >
        Retrieves the `Decision` objects for an People Task (taskId). The
        decisions do not include all candidates, but rather the results of
        concording the requested list of names included in the input file.
        Mapped entities will include a FactSet Entity Identifier (-E). Results
        will be saved to the `universeId` specified in the input file.
      tags:
        - Factset Concordance
      operationId: getPeopleDecisions
      parameters:
        - $ref: '#/components/parameters/peopleTaskDecisionId'
        - $ref: '#/components/parameters/peopleOffset'
        - $ref: '#/components/parameters/peopleLimit'
      responses:
        '200':
          $ref: '#/components/responses/PeopleDecisionsResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '415':
          $ref: '#/components/responses/415'
        '500':
          $ref: '#/components/responses/500'
components:
  securitySchemes:
    UserSecurity:
      type: http
      scheme: basic
      description: Basic Authentication
  parameters:
    name:
      name: name
      description: Name of Entity to match.
      in: query
      schema:
        type: string
      required: true
      example: FactSet
    country:
      name: country
      description: >-
        ISO2 country code corresponding to the entity name that is used when
        evaluating candidates for a match. For a list of ISO2 Country codes,
        visit [OA 8754](https://my.apps.factset.com/oa/pages/8754).
      in: query
      schema:
        type: string
        maxLength: 2
        minLength: 2
      example: US
    state:
      name: state
      description: >-
        Two-character state code corresponding to the entity name that is used
        when evaluating candidates for a match. Currently, only US state codes
        are supported.
      in: query
      schema:
        type: string
        maxLength: 2
        minLength: 2
      example: CT
    url:
      name: url
      description: >-
        URL corresponding to the entity name that is used when evaluating
        candidates for a match.
      in: query
      schema:
        type: string
    includeEntityType:
      name: includeEntityType
      description: >
        Three-character FactSet entity type code used to filter candidates in
        order to determine the final match result. Only candidates with an
        entity type specified will be considered for the final match result.
        Multiple types can be entered separated by commas.
          |Entity Type Code|Entity Type Description|Entity Type Code|Entity Type Description|
          |||||
          |ABS|Asset-Backed||MED|Broadcast Call Sign|
          |BAS|Business Association (JP)||MUC|Mutual Fd-Closed End|
          |CAC|Consolidated Accounting||MUE|Mutual Fd-ETF|
          |CMD|Commodity||MUT|Mutual Fd-Open End|
          |COL|College/University||NPO|Non-Profit Organization|
          |CUR|Currency||OPD|Operating Division|
          |ESP|Emp Stk Ownership Plan||OTH|Other|
          |EXT|Extinct||PEF|Pension Fund|
          |FAF|Family of Fds (VC/Pvt EQ)||PRO|Real Property|
          |FND|Foundation/Endowment||PUB|Public Company|
          |FNS|Financing Subsidiary/SPE||PVF|Private Eq Fd/Alt Invt|
          |FRX|ForEx||PVT|Private Company|
          |GOV|Government||SOV|Sovereign Wealth Fund|
          |HED|Hedge Fund||SUB|Subsidiary|
          |HOL|Holding Company||TRU|Trust/Trustee|
          |IDX|Index||UMB|Umbrella Fund|
          |VEN|Venture Capital Fund||JVT|Joint Venture|
      in: query
      schema:
        type: array
        items:
          type: string
          maxLength: 3
          minLength: 3
          example: PUB
    excludeEntityType:
      name: excludeEntityType
      description: >
        Three-character FactSet entity type code used to filter candidates in
        order to determine the final match result. Candidates with an entity
        type specified will *not* be considered for the final match result.
        Multiple types can be entered separated by commas.
          |Entity Type Code|Entity Type Description|Entity Type Code|Entity Type Description|
          |||||
        |ABS|Asset-Backed||MED|Broadcast Call Sign|

        |BAS|Business Association (JP)||MUC|Mutual Fd-Closed End|

        |CAC|Consolidated Accounting||MUE|Mutual Fd-ETF|

        |CMD|Commodity||MUT|Mutual Fd-Open End|

        |COL|College/University||NPO|Non-Profit Organization|

        |CUR|Currency||OPD|Operating Division|

        |ESP|Emp Stk Ownership Plan||OTH|Other|

        |EXT|Extinct||PEF|Pension Fund|

        |FAF|Family of Fds (VC/Pvt EQ)||PRO|Real Property|

        |FND|Foundation/Endowment||PUB|Public Company|

        |FNS|Financing Subsidiary/SPE||PVF|Private Eq Fd/Alt Invt|

        |FRX|ForEx||PVT|Private Company|

        |GOV|Government||SOV|Sovereign Wealth Fund|

        |HED|Hedge Fund||SUB|Subsidiary|

        |HOL|Holding Company||TRU|Trust/Trustee|

        |IDX|Index||UMB|Umbrella Fund|

        |VEN|Venture Capital Fund||JVT|Joint Venture|
      in: query
      schema:
        type: array
        items:
          type: string
          maxLength: 3
          minLength: 3
          example: EXT
    includeEntitySubType:
      name: includeEntitySubType
      description: >
        Two-character FactSet entity subtype code used to filter candidates in
        order to determine the final match result. Only candidates with an
        entity subtype specified will be considered for the final match result.
        Multiple types can be entered separated by commas.
          |Entity Subtype Code|Entity Subtype Description|Entity Subtype Code|Entity Subtype Description|
          |||||
          |AR|Arbitrage|IC|Investment Company|
          |BM|Bank Investment Division|IN|Insurance Company|
          |BR|Broker|MF|Mutual Fund Manager|
          |CP|Corporate|ML|Master Ltd Part|
          |CU|Custodial|MM|Market Maker|
          |FF|Fund of Funds Manager|PB|Private Banking/Wealth Mgmt|
          |FH|Fund of Hedge Funds Manager|PF|Pension Fund Manager|
          |FO|Foundation/Endowment Manager|PP|Real Estate Manager|
          |FS|Fund Distributor|RE|Research Firm|
          |FU|Fund|SB|Subsidiary Branch|
          |FY|Family Office|ST|Stock Borrowing/Lending|
          |GV|Govt (Fed/Local/Agency)|SV|Sovereign Wealth Manager|
          |HF|Hedge Fund Manager|VC|Venture Capital/Pvt Equity|
          |IA|Investment Adviser|
          |IB|Investment Banking|
      in: query
      schema:
        type: array
        items:
          type: string
          maxLength: 2
          minLength: 2
          example: PR
    excludeEntitySubType:
      name: excludeEntitySubType
      description: >
        Two-character FactSet entity subtype code used to filter candidates in
        order to determine the final match result. Candidates with an entity
        subtype specified will not be considered for the final match result.
        Multiple types can be entered separated by commas.

        |Entity Subtype Code|Entity Subtype Description|Entity Subtype
        Code|Entity Subtype Description|

        |||||

        |AR|Arbitrage|IC|Investment Company|

        |BM|Bank Investment Division|IN|Insurance Company|

        |BR|Broker|MF|Mutual Fund Manager|

        |CP|Corporate|ML|Master Ltd Part|

        |CU|Custodial|MM|Market Maker|

        |FF|Fund of Funds Manager|PB|Private Banking/Wealth Mgmt|

        |FH|Fund of Hedge Funds Manager|PF|Pension Fund Manager|

        |FO|Foundation/Endowment Manager|PP|Real Estate Manager|

        |FS|Fund Distributor|RE|Research Firm|

        |FU|Fund|SB|Subsidiary Branch|

        |FY|Family Office|ST|Stock Borrowing/Lending|

        |GV|Govt (Fed/Local/Agency)|SV|Sovereign Wealth Manager|

        |HF|Hedge Fund Manager|VC|Venture Capital/Pvt Equity|

        |IA|Investment Adviser|

        |IB|Investment Banking|
      in: query
      schema:
        type: array
        items:
          type: string
          example: HF
          maxLength: 2
          minLength: 2
    addParent:
      name: includeParent
      description: >-
        Flag to include parent entities in the list of candidates. This
        parameter does not influence the match result.
      in: query
      schema:
        type: boolean
        example: false
        default: false
    bic:
      description: >-
        Input identifiers for the BICCode - Bank Indentification Code symbol
        Type.
      name: bic
      in: query
      schema:
        type: string
        example: BICCode
    bbgTicker:
      description: >-
        Input identifiers for the Bloomberg Listing and Regional Ticker symbol
        Type.
      name: bbgTicker
      in: query
      schema:
        type: string
        example: BloombergId
    cik:
      description: Input identifiers for the CIK - Edgar Central Index Keys symbol type.
      name: cik
      in: query
      schema:
        type: string
        example: CIK
    crd:
      description: >-
        Input identifiers for the CRD - Central Registration Depository symbol
        type.
      name: crd
      in: query
      schema:
        type: string
        example: CRD
    cusip:
      description: Input identifiers for the CUSIP symbol type.
      name: cusip
      in: query
      schema:
        type: string
        example: CUSIP
    duns:
      description: >-
        Input identifiers for the DUNS - Dun & Bradstreet Data Universal
        Numbering System symbol type.
      name: duns
      in: query
      schema:
        type: string
        example: Dun&Bradstreet
    ein:
      description: >-
        Input identifiers for the EIN - Employer Identification Number symbol
        type.
      name: ein
      in: query
      schema:
        type: string
        example: EmployerIdentificationNumber
    rssd:
      description: Input identifiers for the RSSD - Federal Reserve RSSD symbol typ.
      name: rssd
      in: query
      schema:
        type: string
        example: FederalReserveRSSDIdentifier
    fitch:
      description: Input identifiers for the Fitch - Fitch Ratings symbol type.
      name: fitch
      in: query
      schema:
        type: string
        example: FitchCreditRating
    isin:
      description: >-
        Input identifiers for the ISIN - International Securities Identification
        Number symbol type.
      name: isin
      in: query
      schema:
        type: string
        example: ISIN
    lei:
      description: Input identifiers for the LEI - Legal Entity Identifier symbol type
      name: lei
      in: query
      schema:
        type: string
        example: LegalEntityIdentifier
    bbgFigi:
      description: >-
        Input identifiers for the Bloomberg Listing/Regional/Security ID symbol
        type.
      name: bbgFigi
      in: query
      schema:
        type: string
        example: BBG009S39JY5
    md:
      description: Input identifiers for the Moody's Ratings Identifier type.
      name: md
      in: query
      schema:
        type: string
        example: MoodysIssuer
    ticker:
      description: Input identifiers for the Price Ticker symbol type.
      name: ticker
      in: query
      schema:
        type: string
        example: PriceTicker
    spr:
      description: Input identifiers for the Price Ticker symbol type.
      name: spr
      in: query
      schema:
        type: string
        example: SPRating
    sedol:
      description: Input identifiers for the SEDOL symbol type.
      name: sedol
      in: query
      schema:
        type: string
        example: SEDOL
    tickerExchange:
      description: Input identifiers for the TickerExchange.
      name: tickerExchange
      in: query
      schema:
        type: string
        example: TickerExch
    tickerRegion:
      description: Input identifiers for the TickerRegion.
      name: tickerRegion
      in: query
      schema:
        type: string
        example: TickerRegion
    ukch:
      description: Input identifiers for the UKCH - UK Company House symbol type.
      name: ukch
      in: query
      schema:
        type: string
        example: UKCompanyHouse
    valoren:
      description: Input identifiers for the Valoren ("Valor") symbol type.
      name: valoren
      in: query
      schema:
        type: string
        example: VALOR
    wkn:
      description: Input identifiers for the WKN - German Securities symbol type.
      name: wkn
      in: query
      schema:
        type: string
        example: WKN
    jcn:
      description: >-
        Input identifiers for the type JCN - Japanese Corporate Number symbol
        type.
      name: jcn
      in: query
      schema:
        type: string
        example: JCN
    gvkeyIid:
      description: >-
        Input identifiers for the type GVKEY+IID - Compustat Global Company Key
        and Issue Identifier symbol type.
      name: gvkeyIid
      in: query
      schema:
        type: string
        example: GVKeyIssueIdentifier
    gvkey:
      description: >-
        Input identifiers for the type GVKEY - Compustat Global Company Key
        symbol type.
      name: gvkey
      in: query
      schema:
        type: string
        example: GVKey
    lxid:
      description: >-
        Input identifiers for the type LXID - Markit Syndicated Loan Identifier
        symbol type.
      name: lxid
      in: query
      schema:
        type: string
        example: LXID
    redCode:
      description: >-
        Input identifiers for the type Red Code - Markit Reference Entity
        Identifier symbol type.
      name: redCode
      in: query
      schema:
        type: string
        example: RedCode
    factsetId:
      description: >-
        Input identifiers for the type FactSet Identifier - FactSet -E,-S,-R, -L
        Permanent Identifier symbol type.
      name: factsetId
      in: query
      schema:
        type: string
        example: FactSetIdentifier
    taskDecisionId:
      name: taskId
      description: >-
        Name of the column for the type Concordance Task Identifier. The taskId
        is created in response from the /entity-task endpoint.
      in: query
      schema:
        type: integer
      example: 31589
      required: true
    taskStatusId:
      name: taskId
      description: >-
        Name of the column for the type Concordance Task Identifier. The taskId
        is created in response from the /entity-task endpoint.
      in: query
      schema:
        type: integer
      example: 31589
      required: false
    offset:
      name: offset
      description: Starting row for records to return or rows to skip.
      in: query
      schema:
        type: integer
        default: 0
    limit:
      name: limit
      in: query
      description: Limits the number of records in the response.
      schema:
        type: integer
        maximum: 10000
      example: 10
    status:
      name: status
      description: |
        Filter on the status of the Concordance Tasks. Default is no filter.
          * PENDING - The task has not yet started
          * IN_PROGRESS - The task is submitted and decisions are in progress.
          * SUCCESS - The task was successful! Move to the /entity-decisions endpoint to retrieve decisions.
          * FAILURE - The task failed. Reach out to FactSet Support for assistance.
          * BAD_REQUEST - The task creation was unsuccesfull. Typically occurs with an incorrect input file format or column headers.
          * ABORTED - The task was aborted.
      in: query
      schema:
        type: array
        items:
          type: string
          enum:
            - PENDING
            - IN_PROGRESS
            - SUCCESS
            - FAILURE
            - BAD_REQUEST
            - ABORTED
      explode: false
    mapStatus:
      name: mapStatus
      description: >
        Filter by the Entity Decisions that have the specified mapStatus, where
        -
          * MAPPED - The requested Entity Name is successfully mapped to a FactSet Entity Id (-E)
          * UNMAPPED - The requested Entity Name is unmapped by FactSet.
          * INDETERMINATE - The requested Entity Name was unable to make a mapping.
      in: query
      schema:
        type: array
        items:
          type: string
          enum:
            - MAPPED
            - UNMAPPED
            - INDETERMINATE
        example: MAPPED
    clientIdFilter:
      name: clientId
      description: |
        Filter by the clientId(s) created by the user in a previous mapping.
      in: query
      schema:
        type: array
        items:
          type: string
          example: EXT
      explode: false
      example:
        - abc-123
        - def-456
    clientId:
      name: clientId
      description: |
        Filter by the clientId(s) created by the user in a previous mapping.
      in: query
      schema:
        type: array
        items:
          type: string
          example: EXT
      explode: false
      example:
        - abc-123
        - def-456
    universeId:
      name: universeId
      required: false
      description: >-
        Universe identifier. *To create a universe, use the `/universe'
        endpoint.*
      in: query
      schema:
        type: integer
      example: 1
    universeType:
      name: universeType
      description: Universe Type.
      in: query
      schema:
        type: string
        enum:
          - ENTITY
          - PEOPLE
      example: ENTITY
      explode: false
    universeIdRequired:
      name: universeId
      required: true
      description: >-
        Universe identifier. *To create a universe, use the `/universe'
        endpoint.*
      in: query
      schema:
        type: integer
      example: 1
    sortEntity:
      name: sort
      description: >-
        Sort clientId, createdTime, updatedTime, clientName, entityId fields in
        ascending or descending order with asc and desc to indicate the order.
        Example (clientId:asc)
      in: query
      schema:
        type: array
        items:
          type: string
        example: clientId:asc
      explode: false
      example:
        - clientId:asc
        - clientName:desc
    sortPeople:
      name: sort
      description: >-
        Sort clientId, createdTime, updatedTime, clientPersonName, personId
        fields in ascending or descending order with asc and desc to indicate
        the order. Example (clientId:asc)
      in: query
      schema:
        type: array
        items:
          type: string
        example: clientPersonName:desc
      explode: false
      example:
        - clientId:asc
        - clientPersonName:desc
    universeStatisticsRequired:
      name: universeId
      required: true
      description: >-
        Universe identifier. *To create a universe, use the `/universe'
        endpoint.*
      in: query
      schema:
        type: integer
      example: 1
    personName:
      name: personName
      description: Name of Person to match.
      in: query
      schema:
        type: string
      required: false
      example: Bill Gates
    salutation:
      name: salutation
      description: >-
        Title in person's name. This parameter should not be provided when the
        person name is provided as the input.
      in: query
      schema:
        type: string
      required: false
      example: Mr
    firstName:
      name: firstName
      description: >-
        First name of person. This parameter should not be provided when the
        person name is provided as the input.
      in: query
      schema:
        type: string
      required: false
      example: Bill
    middleName:
      name: middleName
      description: >-
        Middle name of person.This parameter should not be provided when the
        person name is provided as the input.
      in: query
      schema:
        type: string
      required: false
      example: Henry
    lastName:
      name: lastName
      description: >-
        Last name of person. This parameter should not be provided when the
        person name is provided as the input.
      in: query
      schema:
        type: string
      required: false
      example: Gates
    suffix:
      name: suffix
      description: >-
        Suffix in person's name. This parameter should not be provided when the
        person name is provided as the input.
      in: query
      schema:
        type: string
      required: false
      example: III
    entity:
      name: entity
      description: >-
        Entity the person is associated with. It is used to filter the
        candidates before taking a match decision. Can be entity ID or name. The
        supported entity types match the what is supported via the /company
        match.
      in: query
      schema:
        type: string
      required: true
      example: Microsoft
    peopleTaskDecisionId:
      name: taskId
      description: >-
        Concordance Task Identifier. The taskId is created in response from the
        /people-task endpoint.
      in: query
      schema:
        type: integer
      example: 31589
      required: true
    peopleTaskStatusId:
      name: taskId
      description: >-
        Concordance Task Identifier. The taskId is created in response from the
        /people-task endpoint.
      in: query
      schema:
        type: integer
      example: 31589
      required: false
    peopleOffset:
      name: offset
      description: Starting row for records to return or rows to skip.
      in: query
      schema:
        type: integer
        default: 0
    peopleLimit:
      name: limit
      in: query
      description: Limits the number of records in the response.
      schema:
        type: integer
        maximum: 10000
      example: 10
    peopleStatus:
      name: status
      description: |
        Filter on the status of the Concordance Tasks. Default is no filter.
          * PENDING - The task has not yet started
          * IN_PROGRESS - The task is submitted and decisions are in progress.
          * SUCCESS - The task was successful! Move to the /entity-decisions endpoint to retrieve decisions.
          * FAILURE - The task failed. Reach out to FactSet Support for assistance.
          * BAD_REQUEST - The task creation was unsuccesfull. Typically occurs with an incorrect input file format or column headers.
          * ABORTED - The task was aborted.
      in: query
      schema:
        type: array
        items:
          type: string
          enum:
            - PENDING
            - IN_PROGRESS
            - SUCCESS
            - FAILURE
            - BAD_REQUEST
            - ABORTED
      explode: false
  requestBodies:
    EntityMatchRequestV2:
      description: A request to match a Entity.
      required: true
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/EntityMatchRequest'
    EntityMappingRequestV2:
      description: A request to create a single mapping.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EntityMappingRequest'
    PeopleMappingRequestV2:
      description: A request to create a single mapping.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PeopleMappingRequest'
    EntityMappingDeleteRequestV2:
      description: A request to delete entity mappings specified by the client
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EntityMappingDeleteRequest'
    PeopleMappingDeleteRequestV2:
      description: A request to delete people mappings specified by the client
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EntityMappingDeleteRequest'
    EntityUniverseRequest:
      description: A request to fetch all entities of a given universe
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EntityUniverseRequest'
    CreateUniverseRequest:
      description: A request to create a user's universe
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateUniverseRequest'
    UpdateUniverseRequest:
      description: A request to update a user's universe
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateUniverseRequest'
    PeopleUniverseRequest:
      description: A request to fetch all entities of a given universe
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PeopleUniverseRequest'
    SnowflakeEntityMatchRequest:
      description: A request to match an entity name and its attributes within Snowflake.
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SnowflakeEntityMatchRequest'
    SnowflakeEntityMappingRequest:
      description: A request to save entity mappings to a universe
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SnowflakeEntityMappingRequest'
    PeopleMatchRequestV2:
      description: A request to People match.
      required: true
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/PeopleMatchRequest'
  responses:
    '400':
      description: >-
        Bad Request. This can occur for several reasons. Please review the
        "message" for more details.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          examples:
            Bad Request - Missing Required Parameter:
              $ref: '#/components/examples/badRequestRequiredParameter'
            Bad Request - Invalid Parameter:
              $ref: '#/components/examples/badRequestInvalidParameters'
            Bad Request - Malformed JSON:
              $ref: '#/components/examples/badRequestMalformedJSON'
            Bad Request - Read Timeout:
              $ref: '#/components/examples/badRequestReadTimeout'
    '401':
      description: >-
        Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have
        successfully generated an API KEY for the IP range you are connecting
        from. For more help, select the **Report Issue** in the top right corner
        of this Developer Portal specification card and choose Connectivity 401
        or 403 Responses.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          examples:
            Bad Request - Date Format:
              $ref: '#/components/examples/unauthenticated'
    '403':
      description: >-
        The USERNAME-SERIAL attempted to request the endpoint is not authorized
        to access. The request was a legal request, but the server is refusing
        to respond. Please reach out to FactSet Account Team for assistance with
        authorization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          examples:
            Bad Request - forbidden:
              $ref: '#/components/examples/forbidden'
    '415':
      description: >-
        Unsupported Media Type. This error may be returned when the caller sends
        a resource in a format that is not accepted by the server. This can be
        fixed by ensuring that Content-Type header is set to the correct value.
        In this instance, "application/json" would be the appropriate value.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          examples:
            Bad Request - Unsupported Media Type:
              $ref: '#/components/examples/unsupportedMediaType'
    '500':
      description: Internal Server Error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          examples:
            Internal Server Error - Not Writable:
              $ref: '#/components/examples/notWritable'
            Internal Server Error - General Exception:
              $ref: '#/components/examples/generalException'
    EntityMatchResponse:
      description: Response containing Entity Match results.
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/EntityMatchesResponse'
          examples:
            Entity Matches:
              $ref: '#/components/examples/EntityMatches'
    EntityTaskResponse:
      description: OK. The Entity Task creation is submitted.
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/EntityTaskResponse'
          examples:
            Pending Task:
              $ref: '#/components/examples/PendingTask'
    EntityTaskStatusResponse:
      description: Response object for Task Status endpoint.
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/EntityTaskStatusResponse'
          examples:
            Successful Entity Task:
              $ref: '#/components/examples/SuccessfulEntityTasks'
            Pending Task:
              $ref: '#/components/examples/PendingTasks'
            Bad Task:
              $ref: '#/components/examples/BadTasks'
            Failed Task:
              $ref: '#/components/examples/FailedTasks'
    EntityDecisionsResponse:
      description: Response object for Entity Decisions endpoint.
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/EntityDecisionsResponse'
          examples:
            Entity Decisions:
              $ref: '#/components/examples/EntityDecisions'
    EntityUniverseResponse:
      description: Response object for FactSet Concordance Universe detail.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EntityUniverseResponse'
          examples:
            CompanyUniverse:
              $ref: '#/components/examples/EntityUniverse'
    PeopleUniverseResponse:
      description: Response object for FactSet Concordance Universe detail.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PeopleUniverseResponse'
          examples:
            CompanyUniverse:
              $ref: '#/components/examples/PeopleUniverse'
    EntityUniverseStatisticsResponse:
      description: Response object for mapping statistics for a universe
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EntityUniverseStatisticsResponse'
    universeStatisticsResponse:
      description: Response object for mapping statistics for a universe
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/universeStatisticsResponse'
    UniversesResponse:
      description: Metadata on multiple universes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UniversesResponse'
    UniverseMetaResponse:
      description: Metadata on a single universe
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UniverseMetaResponse'
    EntityMappingResponse:
      description: Single entity mapping
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EntityMappingResponse'
    PeopleMappingResponse:
      description: Single people mapping
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PeopleMappingResponse'
          examples:
            PeopleResponse:
              $ref: '#/components/examples/PeopleResponse'
    EntityResponse:
      description: Response object for FactSet Concordance Entity.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EntityResponse'
          examples:
            EntityResponse:
              $ref: '#/components/examples/EntityResponse'
    SnowflakeEntityMatchResponse:
      description: >-
        Response object for the entity-match object in a snowflake friendly
        response model.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SnowflakeEntityMatchResponse'
    SnowflakeEntityMappingResponse:
      description: Response object according to snowflake external function spec
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SnowflakeEntityMappingResponse'
    PeopleMatchResponse:
      description: Response containing People Match results.
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/PeopleMatchesResponse'
          examples:
            People Matches:
              $ref: '#/components/examples/PeopleMatches'
    EntityMappingDeleteResponse:
      description: >-
        Response object for the entity-match object in a snowflake friendly
        response model.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EntityMappingDeleteResponse'
    PeopleMappingDeleteResponse:
      description: Response object for the people-mapping-delete endpoint
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PeopleMappingDeleteResponse'
          examples:
            PeopleResponse:
              $ref: '#/components/examples/PeopleResponse'
    PeopleTaskResponse:
      description: OK. The People Task creation is submitted.
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/PeopleTaskResponse'
          examples:
            Pending Task:
              $ref: '#/components/examples/PeopleTask'
    PeopleTaskStatusResponse:
      description: Response object for People Task Status endpoint.
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/PeopleTaskStatusResponse'
          examples:
            Successful Entity Task:
              $ref: '#/components/examples/SuccessfulPeopleTasks'
            Pending Task:
              $ref: '#/components/examples/PendingTask1'
            Bad Task:
              $ref: '#/components/examples/BadTasks1'
            Failed Task:
              $ref: '#/components/examples/FailedTasks1'
    PeopleDecisionsResponse:
      description: Response object for People Decisions endpoint.
      content:
        application/json;charset=utf-8:
          schema:
            $ref: '#/components/schemas/PeopleDecisionsResponse'
          examples:
            People Decisions:
              $ref: '#/components/examples/PeopleDecisions'
    errorResponse:
      description: Error Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorResponse'
          examples:
            Not Found:
              $ref: '#/components/examples/NotFound'
  schemas:
    EntityMatchRequest:
      title: Entity Match Request
      description: Request object for a requesting multiple Entity Matches.
      type: object
      properties:
        input:
          type: array
          items:
            type: object
            properties:
              name:
                description: The Name of the entity to match.
                type: string
                example: Amazon
              clientId:
                description: >
                  A unique identifier supplied by the user. ClientId is saved to
                  the user's Concordance universe and will be used as the
                  identifier for that entity within the universe.
                type: string
                example: abc-123
              country:
                description: >
                  ISO2 country code corresponding to the entity name that is
                  used when evaluating candidates for a match. For a list of ISO
                  Country codes, visit [OA
                  8754](https://my.apps.factset.com/oa/pages/8754).
                type: string
                maxLength: 2
                minLength: 2
                example: US
              state:
                description: >
                  Two-character state code corresponding to the entity name that
                  is used when evaluating candidates for a match. Currently,
                  only US state codes are supported.Two character state or
                  province code to filter on.
                type: string
                maxLength: 2
                minLength: 2
                example: CT
              url:
                description: >
                  URL corresponding to the entity name that is used when
                  evaluating candidates for a match.
                type: string
                example: www.amazon.com
              priority:
                description: Priority associated to the id.
                type: string
                enum:
                  - CRITICAL
                  - HIGH
                  - MEDIUM
                  - LOW
                example: HIGH
              bbgFigi:
                description: Name for the type Bloomberg Listing/Regional/Security ID.
                type: string
                example: BBG009S39JY5
              bbgTicker:
                description: Name for the type Bloomberg Listing and Regional Ticker.
                type: string
                example: GOOGL UW
              bic:
                description: Name for type BICCode, bank indentification code
                type: string
                example: ABXXHKH1
              cik:
                description: Name for the type CIK, Edgar Central Index Keys
                type: string
                example: 100331
              crd:
                description: Name for the type CRD, Central Registration Depository
                type: string
                example: 149722
              cusip:
                description: Name for the type CUSIP.
                type: string
                example: 02079K305
              duns:
                description: Name for the type DUNS, Dun&Bradstreet.
                type: string
                example: 687741991
              ein:
                description: Name for the type EmployerIdentificationNumber, EIN.
                type: string
                example: 953540776
              factsetId:
                description: >-
                  Name for the type FactSet Identifier, FactSet -E,-S,-R, -L
                  Permanent Identifier.
                type: string
                example: 0013TZ-E
              fitch:
                description: Name for the type FitchCreditRating, Fitch Ratings Identifier.
                type: string
                example: 47504
              gvkey:
                description: Name for the type GVKEY, Compustat Global Company Key.
                type: string
                example: 107481
              gvkeyIid:
                description: >-
                  Name for the type GVKEY+IID, Compustat Global Company Key and
                  Issue Identifier.
                type: string
                example: 107481001
              isin:
                description: Name for the type ISIN.
                type: string
                example: US02079K305
              jcn:
                description: Name for the type JCN , Japanese Corporate Number.
                type: string
                example: 3120001077477
              lei:
                description: Name for the type LegalEntityIdentifier, LEI.
                type: string
                example: 549300A6K7JX8EX2QZ33
              lxid:
                description: Name for the type LXID, Markit Syndicated Loan Identifier.
                type: string
                example: LX113630
              md:
                description: Name for the type MoodysIssuer, Moody's Ratings Identifier.
                type: string
                example: 823736553
              redCode:
                description: Name for the type RedCode, Markit Reference Entity Identifier.
                type: string
                example: 4C933G
              rssd:
                description: Name for the type FederalReserveRSSDIdentifier, RSSD.
                type: string
                example: 1139297
              sedol:
                description: Name for the type SEDOL.
                type: string
                example: BYZ5YB6
              spr:
                description: Name for the type S&PRating, S&P Ratings Identifier.
                type: string
                example: 301939
              ticker:
                description: Name for the type PriceTicker.
                type: string
                example: PriceTicker
              tickerExchange:
                description: Name for the type TickerExch.
                type: string
                example: GOOGL-NAS
              tickerRegion:
                description: Name for the type TickerRegion
                type: string
                example: GOOGL-US
              ukch:
                description: Name for the type UKCompanyHouse
                type: string
                example: CE012494
              valoren:
                description: Name for the type VALOR, Valoren ("Valor") Identification.
                type: string
                example: 685558
              wkn:
                description: Name for the type WKN, German Securities Identification.
                type: string
                example: A0MU9T
              additionalContext:
                description: >
                  Any additional context information along with other input
                  values that need to be saved for an entity during search.  To
                  be used by Managed Service for any unmapped records.  This is
                  applicable when saving the records with clientId and
                  universeId specified.
                type: object
                additionalProperties:
                  type: string
                maxProperties: 5
                example:
                  Address: 123 Main St
                  Phone: 555-555-5555
                  City: New York
            required:
              - name
          minItems: 1
          maxItems: 25
        includeEntityType:
          description: >
            Three-character FactSet entity type code used to filter candidates
            in order to determine the final match result. Only candidates with
            an entity type specified will be considered for the final match
            result. Multiple types can be entered separated by commas
              |Entity Type Code|Entity Type Description|Entity Type Code|Entity Type Description|
              |||||
              |ABS|Asset-Backed||MED|Broadcast Call Sign|
              |BAS|Business Association (JP)||MUC|Mutual Fd-Closed End|
              |CAC|Consolidated Accounting||MUE|Mutual Fd-ETF|
              |CMD|Commodity||MUT|Mutual Fd-Open End|
              |COL|College/University||NPO|Non-Profit Organization|
              |CUR|Currency||OPD|Operating Division|
              |ESP|Emp Stk Ownership Plan||OTH|Other|
              |EXT|Extinct||PEF|Pension Fund|
              |FAF|Family of Fds (VC/Pvt EQ)||PRO|Real Property|
              |FND|Foundation/Endowment||PUB|Public Company|
              |FNS|Financing Subsidiary/SPE||PVF|Private Eq Fd/Alt Invt|
              |FRX|ForEx||PVT|Private Company|
              |GOV|Government||SOV|Sovereign Wealth Fund|
              |HED|Hedge Fund||SUB|Subsidiary|
              |HOL|Holding Company||TRU|Trust/Trustee|
              |IDX|Index||UMB|Umbrella Fund|
              |VEN|Venture Capital Fund||JVT|Joint Venture|
          type: array
          items:
            type: string
            maxLength: 3
            minLength: 3
            example: PUB
        excludeEntityType:
          description: >
            Three-character FactSet entity type code used to filter candidates
            in order to determine the final match result. Candidates with an
            entity type specified will not be considered for the final match
            result. Multiple types can be entered separated by commas.
              |Entity Type Code|Entity Type Description|Entity Type Code|Entity Type Description|
              |||||
              |ABS|Asset-Backed||MED|Broadcast Call Sign|
              |BAS|Business Association (JP)||MUC|Mutual Fd-Closed End|
              |CAC|Consolidated Accounting||MUE|Mutual Fd-ETF|
              |CMD|Commodity||MUT|Mutual Fd-Open End|
              |COL|College/University||NPO|Non-Profit Organization|
              |CUR|Currency||OPD|Operating Division|
              |ESP|Emp Stk Ownership Plan||OTH|Other|
              |EXT|Extinct||PEF|Pension Fund|
              |FAF|Family of Fds (VC/Pvt EQ)||PRO|Real Property|
              |FND|Foundation/Endowment||PUB|Public Company|
              |FNS|Financing Subsidiary/SPE||PVF|Private Eq Fd/Alt Invt|
              |FRX|ForEx||PVT|Private Company|
              |GOV|Government||SOV|Sovereign Wealth Fund|
              |HED|Hedge Fund||SUB|Subsidiary|
              |HOL|Holding Company||TRU|Trust/Trustee|
              |IDX|Index||UMB|Umbrella Fund|
              |VEN|Venture Capital Fund||JVT|Joint Venture|
          type: array
          items:
            type: string
            example: EXT
            maxLength: 3
            minLength: 3
        includeEntitySubType:
          description: >
            Two-character FactSet entity subtype code used to filter candidates
            in order to determine the final match result. Only candidates with
            an entity subtype specified will be considered for the final match
            result. Multiple types can be entered separated by commas.
              |Entity Subtype Code|Entity Subtype Description|Entity Subtype Code|Entity Subtype Description|
              |||||
              |AR|Arbitrage|IC|Investment Company|
              |BM|Bank Investment Division|IN|Insurance Company|
              |BR|Broker|MF|Mutual Fund Manager|
              |CP|Corporate|ML|Master Ltd Part|
              |CU|Custodial|MM|Market Maker|
              |FF|Fund of Funds Manager|PB|Private Banking/Wealth Mgmt|
              |FH|Fund of Hedge Funds Manager|PF|Pension Fund Manager|
              |FO|Foundation/Endowment Manager|PP|Real Estate Manager|
              |FS|Fund Distributor|RE|Research Firm|
              |FU|Fund|SB|Subsidiary Branch|
              |FY|Family Office|ST|Stock Borrowing/Lending|
              |GV|Govt (Fed/Local/Agency)|SV|Sovereign Wealth Manager|
              |HF|Hedge Fund Manager|VC|Venture Capital/Pvt Equity|
              |IA|Investment Adviser|
              |IB|Investment Banking|
          type: array
          items:
            type: string
            example: PR
            maxLength: 2
            minLength: 2
        excludeEntitySubType:
          description: >
            Two-character FactSet entity subtype code used to filter candidates
            in order to determine the final match result. Candidates with an
            entity subtype specified will not be considered for the final match
            result. Multiple types can be entered separated by commas.
              |Entity Subtype Code|Entity Subtype Description|Entity Subtype Code|Entity Subtype Description|
              |||||
              |AR|Arbitrage|IC|Investment Company|
              |BM|Bank Investment Division|IN|Insurance Company|
              |BR|Broker|MF|Mutual Fund Manager|
              |CP|Corporate|ML|Master Ltd Part|
              |CU|Custodial|MM|Market Maker|
              |FF|Fund of Funds Manager|PB|Private Banking/Wealth Mgmt|
              |FH|Fund of Hedge Funds Manager|PF|Pension Fund Manager|
              |FO|Foundation/Endowment Manager|PP|Real Estate Manager|
              |FS|Fund Distributor|RE|Research Firm|
              |FU|Fund|SB|Subsidiary Branch|
              |FY|Family Office|ST|Stock Borrowing/Lending|
              |GV|Govt (Fed/Local/Agency)|SV|Sovereign Wealth Manager|
              |HF|Hedge Fund Manager|VC|Venture Capital/Pvt Equity|
              |IA|Investment Adviser|
              |IB|Investment Banking|
          type: array
          items:
            type: string
            example: HF
            maxLength: 2
            minLength: 2
        includeParent:
          description: >
            Flag to include parent entities in the list of candidates. This
            parameter does not influence the match result.
          type: boolean
          default: false
        universeId:
          description: |
            The universeId to save this set of inputs to
          type: integer
          example: 1
      required:
        - input
    EntityMappingRequest:
      type: object
      required:
        - universeId
        - clientId
        - clientName
      properties:
        universeId:
          description: The universe to save this mapping to.
          type: integer
          example: 1
        clientId:
          description: >-
            A unique identifier supplied by the user. ClientId is saved to the
            user's Concordance universe and will be used as the identifier for
            that entity within the universe.
          type: string
          example: FDS-USA
        entityId:
          description: FactSet Entity Identifier mapped to the submitted entity.
          type: string
          example: 0016YD-E
        clientName:
          description: Name of entity to match.
          type: string
          example: FactSet
        clientCountry:
          description: ISO2 country code corresponding to the Entity name.
          type: string
          example: US
          minLength: 2
          maxLength: 2
        clientState:
          description: ISO Code of State or Province location to map Entity.
          type: string
          example: CT
          minLength: 2
          maxLength: 2
        clientUrl:
          description: URL corresponding to the entity name.
          type: string
          example: www.factset.com
        clientBbgFigi:
          description: >-
            User provided input for Bloomberg Listing/Regional/Security ID
            symbol type.
          type: string
          example: BBG009S39JY5
        clientBbgTicker:
          description: >-
            User provided input for Bloomberg Listing and Regional Ticker symbol
            type.
          type: string
          example: GOOGL UW
        clientBic:
          description: >-
            User provided input for BICCode, bank indentification code symbol
            type.
          type: string
          example: ABXXHKH1
        clientCik:
          description: User provided input for CIK, Edgar Central Index Keys symbol type.
          type: string
          example: 100331
        clientCrd:
          description: >-
            User provided input for CRD, Central Registration Depository symbol
            type.
          type: string
          example: 149722
        clientCusip:
          description: User provided input for CUSIP symbol type.
          type: string
          example: 02079K305
        clientDuns:
          description: User provided input for DUNS, Dun&Bradstreet symbol type.
          type: string
          example: 687741991
        clientEin:
          description: >-
            User provided input for EmployerIdentificationNumber, EIN symbol
            type.
          type: string
          example: 953540776
        clientFactsetId:
          description: >-
            User provided input for FactSet Identifier, FactSet -E,-S,-R, -L
            Permanent Identifier symbol type.
          type: string
          example: 0013TZ-E
        clientFitch:
          description: >-
            User provided input for FitchCreditRating, Fitch Ratings Identifier
            symbol type.
          type: string
          example: 47504
        clientGvkeyIid:
          description: >-
            User provided input for GVKEY+IID, Compustat Global Company Key and
            Issue Identifier symbol type.
          type: string
          example: 107481001
        clientGvkey:
          description: >-
            User provided input for GVKEY, Compustat Global Company Key symbol
            type.
          type: string
          example: 107481
        clientIsin:
          description: User provided input for ISIN symbol type.
          type: string
          example: US02079K305
        clientJcn:
          description: User provided input for JCN , Japanese Corporate Number symbol type.
          type: string
          example: 3120001077477
        clientLei:
          description: User provided input for LegalEntityIdentifier, LEI symbol type.
          type: string
          example: 549300A6K7JX8EX2QZ33
        clientLxid:
          description: >-
            User provided input for LXID, Markit Syndicated Loan Identifier
            symbol type.
          type: string
          example: LX113630
        clientMd:
          description: >-
            User provided input for MoodysIssuer, Moody's Ratings Identifier
            symbol type.
          type: string
          example: 823736553
        clientTicker:
          description: User provided input for PriceTicker symbol type.
          type: string
          example: PriceTicker
        clientPriority:
          description: Name of the priority column as provided by the user.
          type: string
          example: HIGH
        clientRedCode:
          description: >-
            User provided input for RedCode, Markit Reference Entity Identifier
            symbol type.
          type: string
          example: 4C933G
        clientRssd:
          description: >-
            User provided input for FederalReserveRSSDIdentifier, RSSD symbol
            type.
          type: string
          example: 1139297
        clientSedol:
          description: User provided input for SEDOL symbol type.
          type: string
          example: BYZ5YB6
        clientSpr:
          description: User provided input for S&PRating, S&P Ratings Identifier.
          type: string
          example: 301939
        clientTickerExchange:
          description: User provided input for TickerExch symbol type.
          type: string
          example: GOOGL-NAS
        clientTickerRegion:
          description: User provided input for TickerRegion symbol type
          type: string
          example: GOOGL-US
        clientUkch:
          description: User provided input for UKCompanyHouse symbol type
          type: string
          example: CE012494
        clientValoren:
          description: >-
            User provided input for VALOR, Valoren ("Valor") Identification
            symbol type.
          type: string
          example: 685558
        clientWkn:
          description: >-
            User provided input for WKN, German Securities Identification symbol
            type.
          type: string
          example: A0MU9T
        clientAdditionalContext:
          description: >
            Any additional context information that can be saved along with
            other input values for mapping. To be used by Managed Service for
            mapping any unmapped records. 
          type: object
          additionalProperties:
            type: string
          maxProperties: 5
          example:
            Address: 123 Main St
            Phone: 555-555-5555
            City: New York
    PeopleMappingRequest:
      type: object
      required:
        - universeId
        - clientId
        - clientName
      properties:
        clientEntity:
          description: Used to describe the company of the person
          type: string
          example: Microsoft
        clientFirstName:
          description: Used to describe the first name of the person
          type: string
          example: William
        clientId:
          description: >-
            A unique identifier supplied by the user. ClientId is saved to the
            user's Concordance universe and will be used as the identifier for
            that entity within the universe.
          type: string
          example: BGA-123
        clientLastName:
          description: Used to describe the last name of the person.
          type: string
          example: Gates
        clientMiddleName:
          description: Used to describe the middle name of the person.
          type: string
          example: Henry
        clientPersonName:
          description: Used to describe the name of the person
          type: string
          example: Bill Gates
        clientPriority:
          description: Used to indicate the priority of the person
          type: string
          example: HIGH
        clientSalutation:
          description: Used to indicate the salutation of the person
          type: string
          example: Mr
        clientSuffix:
          description: Used to indicate the suffix for the person's name
          type: string
          example: III
        clientAdditionalContext:
          description: >
            Any additional context information that can be saved along with
            other input values for mapping. To be used by Managed Service for
            mapping any unmapped records.
          type: object
          additionalProperties:
            type: string
          maxProperties: 5
          example:
            Address: 123 Main St
            Phone: 555-555-5555
            City: New York
        personId:
          description: A unique identifier used to identify a person.
          type: string
          example: 00118X-E
        universeId:
          description: >-
            A unique identifier supplied to a person to save the data into
            his/her universe.
          type: integer
          example: 1
    EntityMappingDeleteRequest:
      type: object
      required:
        - universeId
        - clientId
      properties:
        universeId:
          description: The universe to save this mapping to.
          type: integer
          example: 1
        clientId:
          description: >-
            A unique identifier supplied by the user. ClientId is saved to the
            user's Concordance universe and will be used as the identifier for
            that entity within the universe.
          type: array
          items:
            type: string
          minItems: 1
          example:
            - abc-123
            - dfg-456
    EntityUniverseRequest:
      type: object
      required:
        - universeId
      properties:
        universeId:
          description: the id of the universe that entities come from
          type: integer
          example: 1
        offset:
          description: starting row of the universe
          type: integer
          example: 0
        limit:
          description: Limits the number of records in the response.
          type: integer
          maximum: 10000
          example: 10
        mapStatus:
          description: >
            Filter by the EPeople Decisions that have the specified mapStatus,
            where -
                  * MAPPED - The requested Entity Name is successfully mapped to a FactSet Entity Id (-E)
                  * UNMAPPED - The requested Entity Name is unmapped by FactSet.
                  * INDETERMINATE - The requested Entity Name was unable to make a mapping.
          type: array
          items:
            type: string
            enum:
              - MAPPED
              - UNMAPPED
              - INDETERMINATE
          example:
            - MAPPED
        clientId:
          description: >-
            fetch only the mappings that has client id included in the specified
            list.
          type: array
          items:
            type: string
          example:
            - abc-123
            - dfg-456
        sort:
          description: fetch according to sort orders
          type: array
          items:
            type: string
          example:
            - clientId:asc
            - clientName:desc
    CreateUniverseRequest:
      type: object
      required:
        - universeName
      properties:
        universeName:
          description: Universe name
          type: string
          example: My Universe
        universeDescription:
          description: Universe description
          type: string
          example: This is my universe
        universeType:
          description: Universe type
          type: string
          example: ENTITY
    UpdateUniverseRequest:
      type: object
      required:
        - universeId
      properties:
        universeName:
          description: Universe name
          type: string
          example: My Universe
        universeDescription:
          description: Universe description
          type: string
          example: This is my universe
        universeId:
          description: Universe identifier
          type: integer
          example: 1
    PeopleUniverseRequest:
      type: object
      required:
        - universeId
      properties:
        universeId:
          description: the id of the universe that entities come from
          type: integer
          example: 1
        offset:
          description: starting row of the universe
          type: integer
          example: 0
        limit:
          description: Limits the number of records in the response.
          type: integer
          example: 10
          maximum: 10000
        mapStatus:
          description: >
            Filter by the People Decisions that have the specified mapStatus,
            where -
                  * MAPPED - The requested Entity Name is successfully mapped to a FactSet Entity Id (-E)
                  * UNMAPPED - The requested Entity Name is unmapped by FactSet.
                  * INDETERMINATE - The requested Entity Name was unable to make a mapping.
          type: array
          items:
            type: string
            enum:
              - MAPPED
              - UNMAPPED
              - INDETERMINATE
          example:
            - MAPPED
        clientId:
          description: >-
            fetch only the mappings that has client id included in the specified
            list.
          type: array
          items:
            type: string
          example:
            - abc-123
            - dfg-456
        sort:
          description: fetch according to sort orders
          type: array
          items:
            type: string
          example:
            - clientId:asc
            - clientPersonName:desc
    SnowflakeEntityMatchRequest:
      title: Snowflake Company Match Request
      type: object
      required:
        - data
      properties:
        data:
          description: Array of input rows
          type: array
          items:
            type: array
            description: One search row from Snowflake
            items:
              type: object
              example: 0
            minItems: 2
            example:
              - 0
              - FactSet
              - US
              - CT
              - www.factset.com
              - 1
              - 10
          minItems: 1
          maxItems: 25
    SnowflakeEntityMappingRequest:
      title: Snowflake Entity Mapping Request
      type: object
      required:
        - data
      properties:
        data:
          description: Array of input rows
          type: array
          items:
            type: array
            items:
              type: object
            description: One entity mapping to save
            minItems: 4
            example:
              - 0
              - 123
              - my_id
              - FactSet
              - 0016YD-E
          minItems: 1
          maxItems: 10
    PeopleMatchRequest:
      title: People Match Request
      description: Request object for a requesting multiple People Matches.
      type: object
      properties:
        input:
          type: array
          items:
            type: object
            properties:
              personName:
                description: The People name to match.
                type: string
                example: Bill Gates
              clientId:
                description: >
                  A unique identifier supplied by the user. ClientId is saved to
                  the user's Concordance universe and will be used as the
                  identifier for that entity within the universe.
                type: string
                example: abc-123
              salutation:
                description: >
                  The salutation is same as the normal salutation we use .The
                  salutation can be Mr, Mrs.The salutation should not be given
                  along with personName.
                type: string
                example: Mr
              firstName:
                description: >
                  The first name of the person. This field should not be given
                  along with personName.
                type: string
                example: Bill
              middleName:
                description: >
                  The middle name of the person. This field should not be given
                  along with personName.
                type: string
                example: Henry
              lastName:
                description: >
                  The last name of the person. This field should not be given
                  along with personName.
                type: string
                example: Gates
              additionalContext:
                description: >
                  Any additional context information along with other input
                  values that need to be saved for an entity during search. To
                  be used by Managed Service for any unmapped records.  This is
                  applicable when saving the records with clientId and
                  universeId specified.
                type: object
                additionalProperties:
                  type: string
                maxProperties: 5
                example:
                  Address: 123 Main St
                  Phone: 555-555-5555
                  City: New York
              suffix:
                description: >
                  The suffix of person's name. This field should not be given
                  along with personName.
                type: string
                example: III
              entity:
                description: |
                  The enity of the Person.
                type: string
                example: Microsoft
        universeId:
          description: |
            The universeId to save this set of inputs to
          type: integer
          example: 1
    EntityMatchesResponse:
      title: Entity Matches Response
      description: Response object for Entity Matches.
      type: object
      properties:
        data:
          description: Candidate list of `Entity Match` objects.
          type: array
          items:
            $ref: '#/components/schemas/EntityMatch'
    EntityTaskResponse:
      title: Entity Task Response
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EntityTaskStatus'
    PeopleTaskResponse:
      title: People Task Response
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PeopleTask'
    EntityTaskStatusResponse:
      title: Entity Task Status Response
      type: object
      properties:
        data:
          description: Array of Concordance Entity Task `Status` objects.
          type: array
          items:
            $ref: '#/components/schemas/EntityTaskStatus'
    EntityDecisionsResponse:
      title: Entity Decisions Response
      type: object
      properties:
        data:
          description: Array of `Entity Match` objects.
          type: array
          items:
            $ref: '#/components/schemas/EntityMatch'
    PeopleDecisionsResponse:
      title: People Decisions Response
      type: object
      properties:
        data:
          description: Array of `People Decisions` objects.
          type: array
          items:
            $ref: '#/components/schemas/PeopleDecisions'
    EntityUniverseResponse:
      title: Entity Universe Response
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EntityMapping'
    PeopleUniverseResponse:
      title: People Universe Response
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PeopleMapping'
    EntityResponse:
      title: Entity Response
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EntityMapping'
    EntityMappingResponse:
      title: Entity Mapping Response
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EntityMapping'
    PeopleMappingResponse:
      title: People Mapping Response
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PeopleMapping'
    UniverseMetaResponse:
      title: Metadata for a single universe
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Universe'
    EntityUniverseStatisticsResponse:
      title: Entity Mapping Statistics Response
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/UniverseStatistics'
    universeStatisticsResponse:
      title: Universe Statistics Response
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/universeStatistics'
    UniversesResponse:
      title: Metadata on multiple universes
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/UniverseMeta'
    SnowflakeEntityMatchResponse:
      title: Snowflake Entity Search Response
      type: object
      example:
        data:
          - clientCountry: us,
            clientId: null,
            clientName: apple,
            clientState: ca,
            clientUrl: www.apple.com,
            confidenceScore: 1.0,
            countryCode: us,
            countryName: United States,
            entityId: 000C7F-E,
            entityName: Apple, Inc.,
            entitySubTypeCode: CP,
            entityTypeCode: PUB,
            entityTypeDescription: Public Company,
            factsetIndustryCode: 1320,
            factsetIndustryName: Telecommunications Equipment,
            factsetSectorCode: 1300,
            factsetSectorName: Electronic Technology,
            locationCity: Cupertino,
            mapStatus: MAPPED,
            matchFlag: true,
            nameMatchSource: Proper/ Legal Name,
            nameMatchString: apple inc,
            parentMatchFlag: false,
            parentName: null,
            regionName: North America,
            rowIndex: 0,
            sicCode: 3663,
            similarityScore: 1.0,
            stateCode: ca,
            stateName: California,
            universeId: 10,
            taskId: null,
            url: www.apple.com,
            clientAdditionalContext: Address
          - clientCountry: null,
            clientId: null,
            clientName: factset,
            clientState: null,
            clientUrl: null,
            confidenceScore: 1.0,
            countryCode: us,
            countryName: United States,
            entityId: 0016YD-E,
            entityName: FactSet Research Systems, Inc.,
            entitySubTypeCode: CP,
            entityTypeCode: PUB,
            entityTypeDescription: Public Company,
            factsetIndustryCode: 3305,
            factsetIndustryName: Data Processing Services,
            factsetSectorCode: 3300,
            factsetSectorName: Technology Services,
            locationCity: Norwalk,
            mapStatus: MAPPED,
            matchFlag: true,
            nameMatchSource: Domain Name,
            nameMatchString: factset,
            parentMatchFlag: false,
            parentName: null,
            regionName: North America,
            rowIndex: 1,
            sicCode: 7374,
            similarityScore: 1.0,
            stateCode: ct,
            stateName: Connecticut,
            universeId: 10,
            taskId: null,
            url: www.factset.com
            clientAdditionalContext: Address
      properties:
        data:
          type: array
          items:
            type: array
            items:
              type: object
          description: JSON body to be parsed by snowflake
    SnowflakeEntityMappingResponse:
      title: Snowflake Entity Mapping Response
      type: object
      example:
        data:
          -   - 0
              - clientBbgFigi:
                clientBbgTicker:
                clientBic:
                clientCik:
                clientCountry: US
                clientCrd:
                clientCusip:
                clientDuns:
                clientEin:
                clientFitch:
                clientId: '1004_1'
                clientIsin:
                clientLei:
                clientMd:
                clientName: IBM
                clientPriority:
                clientRssd:
                clientSedol:
                clientSpr:
                clientState: NY
                clientTicker:
                clientTickerExchange:
                clientTickerRegion:
                clientUkch:
                clientUrl: www.ibm.com
                clientValoren:
                clientWkn:
                clientJcn:
                clientGvkeyIid:
                clientGvkey:
                clientLxid:
                clientRedCode:
                clientFactsetId:
                createdTime: '2023-01-31T18:21:28.853822+00:00'
                entityId: 000N1N-E
                entityName: International Business Machines Corp.
                mapStatus: MAPPED
                universeId: 1241
                updatedTime: '2023-04-10T17:29:31.128197+00:00'
                clientAdditionalContext: Address
          -   - 1
              - clientBbgFigi:
                clientBbgTicker:
                clientBic:
                clientCik:
                clientCountry:
                clientCrd:
                clientCusip:
                clientDuns:
                clientEin:
                clientFitch:
                clientId: '1004_2'
                clientIsin:
                clientLei:
                clientMd:
                clientName: Wayfair
                clientPriority:
                clientRssd:
                clientSedol:
                clientSpr:
                clientState:
                clientTicker:
                clientTickerExchange:
                clientTickerRegion:
                clientUkch:
                clientUrl:
                clientValoren:
                clientWkn:
                clientJcn:
                clientGvkeyIid:
                clientGvkey:
                clientLxid:
                clientRedCode:
                clientFactsetId:
                createdTime: '2023-01-31T18:21:28.853822+00:00'
                entityId:
                entityName:
                mapStatus: UNMAPPED
                universeId: 1241
                updatedTime: '2023-04-10T17:29:47.400250+00:00'
                clientAdditionalContext: Address
      properties:
        data:
          type: array
          items:
            type: array
            description: Array of response rows corresponding to the inputs
            items:
              type: object
              description: >
                Results for a single input row. Of the format [int,
                EntityMapping]
          description: JSON body to be parsed by snowflake
    EntityMappingDeleteResponse:
      title: Entity Delete Mapping Response
      type: object
      properties:
        data:
          description: >-
            Array of `Entity Mapping` objects that have been successfully
            deleted.
          type: array
          items:
            $ref: '#/components/schemas/EntityMapping'
    PeopleMappingDeleteResponse:
      title: People Delete Mapping Response
      type: object
      properties:
        data:
          description: >-
            Array of `People Mapping` objects that have been successfully
            deleted.
          type: array
          items:
            $ref: '#/components/schemas/PeopleMapping'
    PeopleMatchesResponse:
      title: People Matches Response
      description: Response object for People Matches.
      type: object
      properties:
        data:
          description: Candidate list of `People Match` objects.
          type: array
          items:
            $ref: '#/components/schemas/PeopleMatch'
    PeopleTaskStatusResponse:
      title: People Task Status Response
      type: object
      properties:
        data:
          description: Array of Concordance People Task `Status` objects.
          type: array
          items:
            $ref: '#/components/schemas/PeopleTaskStatus'
    errorResponse:
      title: Error Response
      type: object
      properties:
        status:
          description: Status.
          type: string
          example: Bad Request
        timestamp:
          description: Timestamp in yyyy-mm-ddThh:mm:ss.sss format.
          type: string
          example: '2019-11-01T11:09:41.918'
          format: date-time
        path:
          description: The Endpoint path {package}/version/{endpoint}
          type: string
          example: /factset-concordance/v2/entity-match
        message:
          description: The plain text error message.
          type: string
          example: Validation Error
        subErrors:
          description: Sub-errors related to the error message. Null if not applicable.
          type: object
          properties:
            object:
              description: the operation ID
              type: string
            field:
              description: Parameter Field Name
              type: string
            message:
              description: Error message
              type: string
            rejectedValue:
              description: Rejected Values in an Array
              type: array
              items:
                type: string
    EntityMatch:
      title: Entity Match
      description: |
        Entity Match object showing the decision reached for each Entity.
      type: object
      properties:
        taskId:
          description: >
            Identifier denoting a specific Concordance task submitted by the
            user. This value will be null for /entity-match endpoint responses
            and is only available when using the "Bulk" workflow.
          type: integer
          example: 31
          nullable: true
        universeId:
          description: The id of the universe that entities should be mapped to
          type: integer
          example: 1
          nullable: true
        clientId:
          description: >-
            Unique Identifer provided by the user in the request to represent
            the entity Name being requested.
          type: string
          example: abc-123
          nullable: true
        clientBbgFigi:
          description: >-
            Name of the column as provided by the user -  Bloomberg
            Listing/Regional/Security ID.
          type: string
          example: BloombergId
          nullable: true
        clientBbgTicker:
          description: >-
            Name of the column as provided by the user -  Bloomberg Listing and
            Regional Ticker.
          type: string
          example: GOOGL UW
          nullable: true
        clientBic:
          description: >-
            Name of the column as provided by the user - BICCode, bank
            indentification code
          type: string
          example: BICCode
          nullable: true
        clientCik:
          description: >-
            Name of the column as provided by the user -  CIK, Edgar Central
            Index Keys
          type: string
          example: 100331
          nullable: true
        clientCountry:
          description: ISO2 country code specified in the request.
          type: string
          example: US
          nullable: true
        clientCrd:
          description: >-
            Name of the column as provided by the user -  CRD, Central
            Registration Depository
          type: string
          example: 149722
          nullable: true
        clientCusip:
          description: Name of the column as provided by the user -  CUSIP.
          type: string
          example: 02079K305
          nullable: true
        clientDuns:
          description: Name of the column as provided by the user -  DUNS, Dun&Bradstreet.
          type: string
          example: 687741991
          nullable: true
        clientEin:
          description: >-
            Name of the column as provided by the user -  EmployerIdentificationNumber, EIN.
          type: string
          example: 953540776
          nullable: true
        clientFactsetId:
          description: >-
            Name of the column as provided by the user -  FactSet Identifier,
            FactSet -E,-S,-R, -L Permanent Identifier.
          type: string
          example: 0013TZ-E
          nullable: true
        clientFitch:
          description: >-
            Name of the column as provided by the user -  FitchCreditRating,
            Fitch Ratings Identifier.
          type: string
          example: 47504
          nullable: true
        clientGvkey:
          description: >-
            Name of the column as provided by the user -  GVKEY, Compustat
            Global Company Key.
          type: string
          example: 107481
          nullable: true
        clientGvkeyIid:
          description: >-
            Name of the column as provided by the user -  GVKEY+IID, Compustat
            Global Company Key and Issue Identifier.
          type: string
          example: 107481001
          nullable: true
        clientIsin:
          description: Name of the column as provided by the user -  ISIN.
          type: string
          example: ISIN
          nullable: true
        clientJcn:
          description: >-
            Name of the column as provided by the user -  JCN , Japanese
            Corporate Number.
          type: string
          example: 3120001077477
          nullable: true
        clientLei:
          description: >-
            Name of the column as provided by the user -  LegalEntityIdentifier,
            LEI.
          type: string
          example: 549300A6K7JX8EX2QZ33
          nullable: true
        clientLxid:
          description: >-
            Name of the column as provided by the user -  LXID, Markit
            Syndicated Loan Identifier.
          type: string
          example: LX113630
          nullable: true
        clientMd:
          description: >-
            Name of the column as provided by the user -  MoodysIssuer, Moody's
            Ratings Identifier.
          type: string
          example: 823736553
          nullable: true
        clientName:
          description: Name of the entity to match as specified in the request
          type: string
          example: factset
          nullable: true
        clientPriority:
          description: Name of the priority column as provided by the user.
          type: string
          example: HIGH
          nullable: true
        clientRedCode:
          description: >-
            Name of the column as provided by the user -  RedCode, Markit
            Reference Entity Identifier.
          type: string
          example: 4C933G
          nullable: true
        clientRssd:
          description: >-
            Name of the column as provided by the user -  FederalReserveRSSDIdentifier, RSSD.
          type: string
          example: 1139297
          nullable: true
        clientSedol:
          description: Name of the column as provided by the user -  SEDOL.
          type: string
          example: SEDOL
          nullable: true
        clientSpr:
          description: >-
            Name of the column as provided by the user -  S&PRating, S&P Ratings
            Identifier.
          type: string
          example: 301939
          nullable: true
        clientState:
          description: State code specified in the request.
          type: string
          example: CT
          nullable: true
        clientTicker:
          description: Name of the column as provided by the user -  PriceTicker.
          type: string
          example: PriceTicker
          nullable: true
        clientTickerExchange:
          description: Name of the column as provided by the user -  TickerExch.
          type: string
          example: GOOGL-NAS
          nullable: true
        clientTickerRegion:
          description: Name of the column as provided by the user -  TickerRegion
          type: string
          example: GOOGL-US
          nullable: true
        clientUkch:
          description: Name of the column as provided by the user -  UKCompanyHouse
          type: string
          example: CE012494
          nullable: true
        clientUrl:
          description: URL specified in the request.
          type: string
          example: www.factset.com
          nullable: true
        clientValoren:
          description: >-
            Name of the column as provided by the user -  VALOR, Valoren
            ("Valor") Identification.
          type: string
          example: 685558
          nullable: true
        clientWkn:
          description: >-
            Name of the column as provided by the user -  WKN, German Securities
            Identification.
          type: string
          example: A0MU9T
          nullable: true
        clientAdditionalContext:
          description: >
            Any additional context column along with their values in the input
            file or single search.  To be used by Managed Service for any
            unmapped records.
          type: object
          additionalProperties:
            type: string
          example:
            Address: 123 Main St
            Phone: 555-555-5555
            City: New York
        symbolMatchType:
          description: Source type of the Symbol that matched
          type: string
          example: SEDOL
          nullable: true
        rowIndex:
          description: Row number for match in the request or input file.
          type: integer
          nullable: true
        matchFlag:
          description: Flag denoting if the row is a match.
          type: boolean
          nullable: true
        entityId:
          description: >
            FactSet Entity Identifier of the entity matched respective to the
            requested Name submitted. For more detail, visit [FactSet Permanent
            Security
            Identifier](https://oa.apps.factset.com/cms/oaAttachment/64c3213a-f415-4c27-a336-92c73a72deed/24881)
          type: string
          nullable: true
        entityName:
          description: Full name corresponding to the matched entity.
          type: string
          example: FactSet Research Systems, Inc.
          nullable: true
        url:
          description: URL of the matched entity.
          type: string
          example: www.factset.com
          nullable: true
        mapStatus:
          description: |
            Concordance status of the submitted, where - 
              * MAPPED - The requested Entity Name is successfully mapped to a FactSet Entity Id (-E)
              * UNMAPPED - The requested Entity Name is unmapped by FactSet.
              * INDETERMINATE - The requested Entity Name has unable to make a mapping.
          type: string
          enum:
            - MAPPED
            - UNMAPPED
            - INDETERMINATE
          example: MAPPED
          nullable: true
        similarityScore:
          description: >
            Probability of the match being similar to the entity requested as
            determined by the Concordance algorithm. A similarityScore of 1 is
            the highest level of similarity.
          type: number
          format: double
          example: 1
          nullable: true
        confidenceScore:
          description: >
            Additional statistic calculated by the algorithm that is used to
            ensure the validity of the match result. A confidenceScore of 1 is
            the highest level of confidence.
          type: number
          format: double
          example: 1
          nullable: true
        countryCode:
          description: >-
            ISO2 country code corresponding to the location of the matched
            entity.
          type: string
          example: US
          nullable: true
        countryName:
          description: Country name corresponding to the location of the matched entity
          type: string
          example: United States
          nullable: true
        stateCode:
          description: >-
            Two character state code corresponding to the location of the
            matched entity.
          type: string
          example: CT
          nullable: true
        stateName:
          description: State name corresponding to the location of the matched entity.
          type: string
          example: Connecticut
          nullable: true
        sicCode:
          description: Standard Industrial Classification (SIC) Code of the matched entity.
          type: string
          example: 7374
          nullable: true
        entityTypeCode:
          description: >-
            Code representing the entity type of the matched entity. See the
            related request parameter for a table of all Codes and their
            respective descriptions.
          type: string
          example: PUB
          nullable: true
        entityTypeDescription:
          description: Description of of the matched entity's type.
          type: string
          example: Public Company
          nullable: true
        entitySubTypeCode:
          description: >-
            Code representing the entity subtype of the matched entity. See the
            related request parameter for a table of all Codes and their
            respective descriptions.
          type: string
          example: PR
          nullable: true
        locationCity:
          type: string
          example: Norwalk
          nullable: true
          description: City where the matched entity is located.
        regionName:
          description: Region where the matched entity is located.
          type: string
          example: North America
          nullable: true
        factsetIndustryCode:
          description: FactSet Industry Classification Code of the matched entity.
          type: string
          example: 3305
          nullable: true
        factsetIndustryName:
          description: Name of the matched entity's FactSet Industry Classification.
          type: string
          example: Data Processing Services
          nullable: true
        factsetSectorCode:
          description: Name of the matched entity's FactSet Sector Classification Code.
          type: string
          example: 3300
          nullable: true
        factsetSectorName:
          description: Name of the matched entity's FactSet Sector Classification.
          type: string
          example: Technology Services
          nullable: true
        parentName:
          description: Name of the matched entity's parent entity.
          type: string
          nullable: true
        parentMatchFlag:
          description: >-
            Flag denoting that the matched entity is the parent of another
            match.
          type: boolean
          example: false
          nullable: true
        nameMatchString:
          description: >-
            String on which the Concordance algorithm mapped the submitted
            entity.
          type: string
          example: factset
          nullable: true
        nameMatchSource:
          description: Type of name that the nameMatchString matched.
          type: string
          example: Domain Name
          nullable: true
    EntityTaskStatus:
      title: Entity Task Status
      description: >
        Concordance Entity Task Status object. Shows the settings and status of
        a taskId and some statistics on the matches.
      type: object
      properties:
        taskId:
          description: >-
            Identifier denoting a specific Concordance task submitted by the
            user.
          type: integer
          example: 31
          nullable: true
        taskName:
          description: User-defined name for the task used to name the output file.
          type: string
          example: test31
          nullable: true
        taskAction:
          description: Action status for the Concordance Task process.
          type: string
          example: processfile
          nullable: true
        status:
          description: >-
            Status of the Concordance Task. If the value is "SUCCESS", you can
            move to the subsequent /entity-decisions endpoint to retrieve the
            results.
          type: string
          enum:
            - PENDING
            - IN_PROGRESS
            - SUCCESS
            - FAILURE
            - BAD_REQUEST
            - ABORTED
          nullable: true
        inputFile:
          description: |
            The input file is posted as a file object in the form.
          type: string
          example: test31.csv
          nullable: true
        clientIdColumn:
          description: >-
            Name of the column in the input file that contains a unique
            identifier supplied by the user.
          type: string
          example: ClientId
          nullable: true
        priorityColumn:
          description: >
            Header Name of the column in the inputfile that contains the
            priority for the client id
          type: string
          example: Priority
          nullable: true
        bbgFigiColumn:
          description: >-
            Header Name of the column in the input file for the type Bloomberg
            Listing/Regional/Security ID.
          type: string
          example: BloombergId
          nullable: true
        bbgTickerColumn:
          description: >-
            Header Name of the column in the input file for the type Bloomberg
            Listing and Regional Ticker.
          type: string
          example: BloombergTicker
          nullable: true
        bicColumn:
          description: >-
            Header Name of the column in the input file for the type BICCode,
            bank indentification code.
          type: string
          example: BICCode
          nullable: true
        cikColumn:
          description: >-
            Header Name of the column in the input file for the type CIK, Edgar
            Central Index Keys.
          type: string
          example: CIK
          nullable: true
        crdColumn:
          description: >-
            Header Name of the column in the input file for the type CRD,
            Central Registration Depository.
          type: string
          example: CRD
          nullable: true
        cusipColumn:
          description: Header Name of the column in the input file for the type CUSIP.
          type: string
          example: CUSIP
          nullable: true
        dunsColumn:
          description: >-
            Header Name of the column in the input file for the type DUNS,
            Dun&Bradstreet.
          type: string
          example: Dun&Bradstreet
          nullable: true
        einColumn:
          description: >-
            Header Name of the column in the input file for the type
            EmployerIdentificationNumber, EIN.
          type: string
          example: EmployerIdentificationNumber
          nullable: true
        factsetIdColumn:
          description: >-
            Header Name of the column in the input file for the type FactSet
            Identifier - `FactSet -E,-S,-R, -L Permanent Identifier.
          type: string
          example: FactSet Identifier
          nullable: true
        fitchColumn:
          description: >-
            Header Name of the column in the input file for the type
            FitchCreditRating, Fitch Ratings Identifier.
          type: string
          example: FitchCreditRating
          nullable: true
        gvkeyColumn:
          description: >-
            Header Name of the column in the input file for the type GVKEY -
            Compustat Global Company Key.
          type: string
          example: GVKey
          nullable: true
        gvkeyIidColumn:
          description: >-
            Header Name of the column in the input file for the type GVKEY+IID -
            Compustat Global Company Key and Issue Identifier.
          type: string
          example: GVKey+Iid
          nullable: true
        isinColumn:
          description: Header Name of the column in the input file for the type ISIN.
          type: string
          example: ISIN
          nullable: true
        jcnColumn:
          description: >-
            Header Name of the column in the input file for the type JCN -
            Japanese Corporate Number.
          type: string
          example: JCN
          nullable: true
        leiColumn:
          description: >-
            Header Name of the column in the input file for the type
            LegalEntityIdentifier, LEI.
          type: string
          example: LegalEntityIdentifier
          nullable: true
        lxidColumn:
          description: >-
            Header Name of the column in the input file for the type LXID -
            Markit Syndicated Loan Identifier.
          type: string
          example: LXID
          nullable: true
        mdColumn:
          description: >-
            Header Name of the column in the input file for the type
            MoodysIssuer, Moody's Ratings Identifier.
          type: string
          example: MoodysIssuer
          nullable: true
        redCodeColumn:
          description: >-
            Header Name of the column in the input file for the type Red Code -
            Markit Reference Entity Identifier.
          type: string
          example: Red Code
          nullable: true
        rssdColumn:
          description: >-
            Header Name of the column in the input file for the type
            FederalReserveRSSDIdentifier, RSSD.
          type: string
          example: FederalReserveRSSDIdentifier
          nullable: true
        sedolColumn:
          description: Header Name of the column in the input file for the type SEDOL.
          type: string
          example: SEDOL
          nullable: true
        sprColumn:
          description: >-
            Header Name of the column in the input file for the type S&PRating,
            S&P Ratings Identifier
          type: string
          example: SPRating
          nullable: true
        tickerColumn:
          description: >-
            Header Name of the column in the input file for the type
            PriceTicker.
          type: string
          example: PriceTicker
          nullable: true
        tickerExchangeColumn:
          description: Header Name of the column in the input file for the type TickerExch.
          type: string
          example: TickerExch
          nullable: true
        tickerRegionColumn:
          description: >-
            Header Name of the column in the input file for the type
            TickerRegion.
          type: string
          example: TickerRegion
          nullable: true
        ukchColumn:
          description: >-
            Header Name of the column in the input file for the type
            UKCompanyHouse.
          type: string
          example: UKCompanyHouse
          nullable: true
        valorenColumn:
          description: >-
            Header Name of the column in the input file for the type VALOR,
            Valoren ("Valor") Identification.
          type: string
          example: VALOR
          nullable: true
        wknColumn:
          description: >-
            Header Name of the column in the input file for the type WKN, German
            Securities Identification.
          type: string
          example: WKN
          nullable: true
        nameColumn:
          description: >-
            Name of the column in the input file that contains the entity name
            to be matched.
          type: string
          example: Name
          nullable: true
        countryColumn:
          description: >
            Name of the column in the input file that contains the ISO2 country
            code corresponding to the entity name.  The country code is used
            when evaluating candidates for a match.
          type: string
          example: Country
          nullable: true
        stateColumn:
          description: >
            Name of the column in the input file that contains the Two-character
            state code corresponding to the entity name. The state code is used
            when evaluating candidates for a match.
          type: string
          example: State
          nullable: true
        urlColumn:
          description: >
            Name of the column in the input file that contains the URL
            corresponding to the entity name. The URL is used when evaluating
            candidates for a match.
          type: string
          example: URL
          nullable: true
        additionalContextColumns:
          description: >
            Comma separated list of any additional column names in the input
            file.  To be used by Managed Service for any unmapped records.
          type: array
          maxItems: 5
          items:
            type: string
          example:
            - Address
            - Phone
            - City
        hasResult:
          description: Flag denoting the taskId has a result.
          type: boolean
          example: true
          nullable: true
        taskSubmitTime:
          description: Time the Task was submitted in UTC.
          type: string
          format: date-time
          example: 2020-06-24T22:02:21Z
          nullable: true
        message:
          description: Textual message for the status.
          type: string
          example: Waiting for the input file
          nullable: true
        inputCount:
          description: Number of records in the Input File.
          type: integer
          example: 11
          nullable: true
        mappedCount:
          description: Number of records with status of MAPPED the Input File.
          type: integer
          example: 8
          nullable: true
        unmappedCount:
          description: Number of records with status of UNMAPPED the Input File.
          type: integer
          example: 2
          nullable: true
        indeterminateCount:
          description: Number of records with status of INDETERMINATE the Input File.
          type: integer
          example: 1
          nullable: true
        processStartTime:
          description: Process start time in UTC.
          type: string
          format: date-time
          example: 2020-07-03T15:12:06.722000Z
          nullable: true
        processDuration:
          description: Process duration in seconds.
          type: number
          format: double
          example: 1.51603
          nullable: true
        tryCount:
          description: Number of tries made so far for the request.
          type: integer
          example: 3
          nullable: true
        decisionRate:
          description: Percentage of mapped entities in the Input File.
          type: number
          format: double
          example: 0.7272727272727273
          nullable: true
        error:
          type: string
          nullable: true
        errorTitle:
          type: string
          nullable: true
        includeEntityType:
          description: |
            Requested Entity types to include.
          type: array
          items:
            type: string
            example: PUB
            nullable: true
        excludeEntityType:
          description: |
            Requested Entity types to exclude.
          type: array
          items:
            type: string
            example: EXT
            nullable: true
        includeEntitySubType:
          description: |
            Requested Entity subtypes to include.
          type: array
          items:
            type: string
            example: PR
            nullable: true
        excludeEntitySubType:
          description: |
            Requested Entity subtypes to exclude.
          type: array
          items:
            type: string
            example: IB
            nullable: true
        userSerial:
          description: user-serial of the person who initiated the entity task.
          type: string
          example: FDSQAR_C-000000
          nullable: true
        userFullName:
          description: |
            Full name of the person associated with the `userSerial`.
          type: string
          example: Jane Smith
          nullable: true
        universeId:
          description: |
            The universe id this task was submitted to.
          type: integer
          example: 1
          nullable: true
        universeName:
          description: |
            The name of the universe this task was submitted to.
          type: string
          example: My Universe
          nullable: true
    EntityMapping:
      title: Entity Mapping
      description: >
        Concordance Company Entity Mapping object. Shows the mapping detail
        related to user's universe.
      type: object
      properties:
        entityId:
          description: >-
            FactSet Entity Identifier of the entity matched to the submitted
            entity
          type: string
          example: 00456-E
          nullable: true
        entityName:
          description: Full name corresponding to the matched entity.
          type: string
          example: FactSet Inc.
          nullable: true
        clientId:
          description: User-defined unique identifier provided by the user in the request
          type: string
          example: abc-1234
          nullable: true
        clientName:
          description: Name of the entity to match as specified in the request.
          type: string
          example: factset
          nullable: true
        clientCountry:
          description: ISO2 country code specified in the request
          type: string
          example: us
          nullable: true
        clientState:
          description: State code specified in the request
          type: string
          example: ct
          nullable: true
        clientPriority:
          description: Priority associated to the id.
          type: string
          example: HIGH
          nullable: true
        clientBbgFigi:
          description: >-
            Name as provided by the user for the type Bloomberg
            listing/regional/security id.
          type: string
          example: BBG009S39JY5
          nullable: true
        clientBbgTicker:
          description: >-
            Name as provided by the user for the type Bloomberg listing and
            regional ticker.
          type: string
          example: GOOGL UW
          nullable: true
        clientBic:
          description: >-
            Name as provided by the user for the type BIC - Bank Indentification
            Code.
          type: string
          example: ABXXHKH1
          nullable: true
        clientCik:
          description: >-
            Name as provided by the user for the type CIK - Edgar Central Index
            Keys.
          type: string
          example: 100331
          nullable: true
        clientCrd:
          description: >-
            Name as provided by the user for the type CRD - Central Registration
            Depository.
          type: string
          example: 149722
          nullable: true
        clientCusip:
          description: Name as provided by the user for the type CUSIP.
          type: string
          example: 02079K305
          nullable: true
        clientDuns:
          description: >-
            Name as provided by the user for the type DUNS - Dun & Bradstreet
            Data Universal Numbering System.
          type: string
          example: 687741991
          nullable: true
        clientEin:
          description: >-
            Name as provided by the user for the type EIN - Employer
            Identification Number.
          type: string
          example: 953540776
          nullable: true
        clientFactsetId:
          description: >-
            Name as provided by the user for the type FactSet Identifier,
            FactSet -E,-S,-R, -L Permanent Identifier.
          type: string
          example: 0013TZ-E
          nullable: true
        clientFitch:
          description: >-
            Name as provided by the user for the type Fitch - Fitch Ratings
            Identifier.
          type: string
          example: 47504
          nullable: true
        clientGvkey:
          description: >-
            Name as provided by the user for the type GVKEY, Compustat Global
            Company Key.
          type: string
          example: 107481
          nullable: true
        clientGvkeyIid:
          description: >-
            Name as provided by the user for the type GVKEY+IID, Compustat
            Global Company Key and Issue Identifier.
          type: string
          example: 107481001
          nullable: true
        clientIsin:
          description: >-
            Name as provided by the user for the type ISIN - International
            Securities Identification Number.
          type: string
          example: US02079K305
          nullable: true
        clientJcn:
          description: >-
            Name as provided by the user for the type JCN , Japanese Corporate
            Number.
          type: string
          example: 3120001077477
          nullable: true
        clientLei:
          description: >-
            Name as provided by the user for the type LEI - Legal Entity
            Identifier.
          type: string
          example: 549300A6K7JX8EX2QZ33
          nullable: true
        clientLxid:
          description: >-
            Name as provided by the user for the type LXID, Markit Syndicated
            Loan Identifier.
          type: string
          example: LX113630
          nullable: true
        clientMd:
          description: >-
            Name as provided by the user for the type Moody's ratings
            identifier.
          type: string
          example: 823736553
          nullable: true
        clientRedCode:
          description: >-
            Name as provided by the user for the type RedCode, Markit Reference
            Entity Identifier.
          type: string
          example: 4C933G
          nullable: true
        clientRssd:
          description: >-
            Name as provided by the user for the type RSSD - Federal Reserve
            RSSD Identifier.
          type: string
          example: 1139297
          nullable: true
        clientSedol:
          description: Name as provided by the user for the type SEDOL.
          type: string
          example: BYZ5YB6
          nullable: true
        clientSpr:
          description: Name as provided by the user for the type S&P ratings identifier.
          type: string
          example: 301939
          nullable: true
        clientTicker:
          description: Name as provided by the user for the type price ticker.
          type: string
          example: GOOGL
          nullable: true
        clientTickerExchange:
          description: Name as provided by the user for the type ticker exchange.
          type: string
          example: GOOGL-NAS
          nullable: true
        clientTickerRegion:
          description: Name as provided by the user for the type ticker region.
          type: string
          example: GOOGL-US
          nullable: true
        clientUkch:
          description: >-
            Name as provided by the user for the type UK company house
            identifier.
          type: string
          example: CE012494
          nullable: true
        clientValoren:
          description: >-
            Name as provided by the user for the type Valoren - Valor
            Identification.
          type: string
          example: 685558
          nullable: true
        clientWkn:
          description: >-
            Name as provided by the user for the type WKN - German Securities
            Identification.
          type: string
          example: A0MU9T
          nullable: true
        clientAdditionalContext:
          description: >
            Any additional context column along with their values in the input
            file or single search.  To be used by Managed Service for any
            unmapped records.
          type: object
          additionalProperties:
            type: string
          example:
            Address: 123 Main St
            Phone: 555-555-5555
            City: New York
        clientUrl:
          description: URL specified in the request
          type: string
          example: www.factset.com
          nullable: true
        createdTime:
          description: Time when entity was created in UTC.
          type: string
          format: date-time
          example: 2020-06-24T22:02:21Z
          nullable: true
        updatedTime:
          description: Time when the submitted entity was last updated in UTC.
          type: string
          format: date-time
          example: 2020-06-24T22:02:21Z
          nullable: true
        mapStatus:
          description: Current status of the entity mapping.
          type: string
          nullable: true
          enum:
            - MAPPED
            - UNMAPPED
            - INDETERMINATE
        universeId:
          description: |
            The universe this mapping belongs to. Only set in v2 endpoints
          type: integer
          example: 1
          nullable: true
    PeopleMapping:
      title: People Mapping
      description: >
        Concordance People Mapping object. Shows the mapping detail related to
        user's universe.
      type: object
      properties:
        clientEntity:
          description: It describes the name of the company
          type: string
          example: Microsoft
          nullable: true
        clientFirstName:
          description: It indicates the full name of the client.
          type: string
          example: William
          nullable: true
        clientId:
          description: User-defined unique identifier provided by the user in the request
          type: string
          example: BGA-123
          nullable: true
        clientLastName:
          description: It indicates last name of the client.
          type: string
          example: Gates
          nullable: true
        clientMiddleName:
          description: It indicates middle name of the client.
          type: string
          example: Henry
          nullable: true
        clientPersonName:
          description: It indiactes the name of the client
          type: string
          example: Bill Gates
          nullable: true
        clientPriority:
          description: It indiactes the priority value of the client.
          type: string
          example: HIGH
          nullable: true
        clientSalutation:
          description: It indicates the client's salutation.
          type: string
          example: Mr
          nullable: true
        clientSuffix:
          description: It indicates the suffix for the client.
          type: string
          example: III
          nullable: true
        clientAdditionalContext:
          description: >
            Any additional context information that can be saved along with
            other input values for mapping. To be used by Managed Service for
            mapping any unmapped records.
          type: object
          additionalProperties:
            type: string
          maxProperties: 5
          example:
            Address: 123 Main St
            Phone: 555-555-5555
            City: New York
        createdTime:
          description: It indicates the time of the creation
          type: string
          format: date-time
          example: 2020-06-24T22:02:21Z
          nullable: true
        mapStatus:
          description: Current status of the people mapping.
          type: string
          enum:
            - MAPPED
            - UNMAPPED
            - INDETERMINATE
          example: MAPPED
          nullable: true
        personId:
          description: |
            Helps to identify a person by using an unique indiactor
          type: string
          example: 00118X-E
          nullable: true
        personName:
          description: It indiactes the full name of the client
          type: string
          example: GATES WILLIAM H III
          nullable: true
        universeId:
          description: |
            The universe this mapping belongs to. Only set in v2 endpoints
          type: integer
          example: 1
          nullable: true
        updatedTime:
          description: It indicates the time of the updation
          type: string
          format: date-time
          example: 2020-06-24T22:02:21Z
          nullable: true
    UniverseStatistics:
      title: Universe Statistics
      description: Mapping statistics for a given universe
      type: object
      properties:
        totalCount:
          type: integer
          example: 10
          nullable: true
        mappedCount:
          type: integer
          example: 8
          nullable: true
        unmappedCount:
          type: integer
          example: 1
          nullable: true
        indeterminateCount:
          type: integer
          example: 1
          nullable: true
        universeId:
          type: integer
          example: 1
          nullable: true
    universeStatistics:
      title: Universe Statistics
      description: Mapping statistics for a given universe
      type: object
      properties:
        totalCount:
          type: integer
          example: 10
          nullable: true
        mappedCount:
          type: integer
          example: 8
          nullable: true
        unmappedCount:
          type: integer
          example: 1
          nullable: true
        indeterminateCount:
          type: integer
          example: 1
          nullable: true
        universeId:
          type: integer
          example: 1
          nullable: true
    MapStatus:
      description: Status of an entity mapping
      type: string
      example: MAPPED
      enum:
        - MAPPED
        - UNMAPPED
        - INDETERMINATE
    UniverseMeta:
      title: Universe Meta
      description: Metadata about a single universe
      type: object
      properties:
        universeId:
          description: The universe identifier
          type: integer
          example: 1
          nullable: true
        universeName:
          description: The user specified universe name
          type: string
          example: My Universe
          nullable: true
        universeDescription:
          description: The user specified universe description
          type: string
          example: This is a universe
          nullable: true
        universeType:
          description: The user specified universe type.
          type: string
          example: ENTITY
          nullable: true
        selfManaged:
          description: >-
            False if the universe is managed by FactSet Managed Service, True
            otherwise
          type: boolean
          example: true
          nullable: true
        createdBy:
          description: The user who created the universe
          type: string
          example: FDSQAR_C-000000
          nullable: true
        createdOn:
          description: When the universe was created
          type: string
          format: date-time
          example: '2020-01-01T00:00:00.000'
          nullable: true
        updatedBy:
          description: The user who most recently updated the universe metadata
          type: string
          example: FDSQAR_C-000000
          nullable: true
        updatedOn:
          description: When the universe metadata was most recently updated
          type: string
          format: date-time
          example: '2020-01-01T00:00:00.000'
          nullable: true
    Universe:
      title: Universe Meta
      description: Metadata about a single universe
      type: object
      properties:
        universeId:
          description: The universe identifier
          type: integer
          example: 1
          nullable: true
        universeName:
          description: The user specified universe name
          type: string
          example: My Universe
          nullable: true
        universeDescription:
          description: The user specified universe description
          type: string
          example: This is a universe
          nullable: true
        universeType:
          description: The user specified universe entity.
          type: string
          example: ENTITY
          nullable: true
        selfManaged:
          description: >-
            False if the universe is managed by FactSet Managed Service, True
            otherwise
          type: boolean
          example: true
          nullable: true
        createdBy:
          description: The user who created the universe
          type: string
          example: FDSQAR_C-000000
          nullable: true
        createdOn:
          description: When the universe was created
          type: string
          format: date-time
          example: '2020-01-01T00:00:00.000'
          nullable: true
        updatedBy:
          description: The user who most recently updated the universe metadata
          type: string
          example: FDSQAR_C-000000
          nullable: true
        updatedOn:
          description: When the universe metadata was most recently updated
          type: string
          format: date-time
          example: '2020-01-01T00:00:00.000'
          nullable: true
    PeopleMatch:
      title: People Match
      description: |
        People Match object showing the decision reached for each Entity.
      type: object
      properties:
        taskId:
          description: >
            Identifier denoting a specific Concordance task submitted by the
            user. This value will be null for /people-match endpoint responses
            and is only available when using the "Bulk" workflow.
          type: integer
          example: 31
          nullable: true
        activeRole:
          description: This tells whether the person is now active in the entity
          type: string
          example: true
          nullable: true
        clientEntity:
          description: |
            The entity for which the person is working.
          type: string
          example: Factset
          nullable: true
        clientFirstName:
          description: >-
            First Name provided in the input file which is used in the
            `people-task` endpoint
          type: string
          example: Elon
          nullable: true
        clientLastName:
          description: >-
            Last Name provided in the input file which is used in the
            `people-task` endpoint
          type: string
          example: Musk
          nullable: true
        clientMiddleName:
          description: >-
            Middle Name provided in the input file which is used in the
            `people-task` endpoint
          type: string
          example: Federick
          nullable: true
        clientSalutation:
          description: >-
            Salutation provided in the input file which is used in the
            `people-task` endpoint
          type: string
          example: Mr
          nullable: true
        clientSuffix:
          description: >-
            Suffix provided in the input file which is used in the `people-task`
            endpoint
          type: string
          example: Sir
          nullable: true
        clientPriority:
          description: >-
            Priority provided in the input file which is used in the
            `people-task` endpoint
          type: string
          example: HIGH
          nullable: true
        clientPersonName:
          description: The person name as provided in request.
          type: string
          example: Phil Snow
          nullable: true
        clientAdditionalContext:
          description: >
            Any additional context column along with their values in the input
            file or single search.  To be used by Managed Service for any
            unmapped records.
          type: object
          additionalProperties:
            type: string
          example:
            Address: 123 Main St
            Phone: 555-555-5555
            City: New York
        firstName:
          description: The first name of the client.
          type: string
          example: Frederick
          nullable: true
        personId:
          description: The id of the person.
          type: string
          example: 0DPHLH-E
          nullable: true
        lastName:
          description: The last name of the person.
          type: string
          example: Snow
          nullable: true
        middleName:
          description: The middle name of the client.
          type: string
          example: Philip
          nullable: true
        suffix:
          description: The suffix in the name of the person
          type: string
          example: III
          nullable: true
        salutation:
          description: Title of a person's name
          type: string
          example: Mr.
          nullable: true
        personName:
          description: Full name of the person matched
          type: string
          example: GATES WILLIAM H III
          nullable: true
        email:
          description: Email of the person
          type: string
          example: abc@efg.com
          nullable: true
        clientId:
          description: User defined person id provided when matched with FactSet person.
          type: string
          example: abc-123
          nullable: true
        entity:
          description: Full name corresponding to the matched entity.
          type: string
          example: FACTSET RESEARCH SYSTEMS INC.
          nullable: true
        mapStatus:
          description: |
            Concordance status of the submitted, where - 
              * MAPPED - The requested Entity Name is successfully mapped to a FactSet Entity Id (-E)
              * UNMAPPED - The requested Entity Name is unmapped by FactSet.
              * INDETERMINATE - The requested Entity Name has unable to make a mapping.
          type: string
          enum:
            - MAPPED
            - UNMAPPED
            - INDETERMINATE
          example: MAPPED
          nullable: true
        matchFlag:
          description: >
            Probability of the match being similar to the entity requested as
            determined by the Concordance algorithm. A similarityScore of 1 is
            the highest level of similarity.
          type: string
          example: true
          nullable: true
        nameMatchSource:
          description: >
            Additional statistic calculated by the algorithm that is used to
            ensure the validity of the match result. A confidenceScore of 1 is
            the highest level of confidence.
          type: string
          example: Presentation Name
          nullable: true
        nameMatchString:
          description: >-
            String on which the Concordance algorithm mapped the submitted
            entity.
          type: string
          example: philip snow
          nullable: true
        rowIndex:
          description: Country name corresponding to the location of the matched entity
          type: integer
          format: double
          example: 0
          nullable: true
        similarityScore:
          description: >
            Probability of the match being similar to the entity requested as
            determined by the Concordance algorithm. A similarityScore of 1 is
            the highest level of similarity.
          type: number
          format: double
          example: 1
          nullable: true
        title:
          description: The title that the person is holding.
          type: string
          example: Chief Executive Officer & Director
          nullable: true
        universeId:
          description: The universe identifier
          type: integer
          example: 1
          nullable: true
    PeopleTask:
      title: People Task
      description: >
        Concordance People Task object. Shows the settings and status of a
        taskId and some statistics on the matches.
      type: object
      properties:
        clientIdColumn:
          description: |
            The number of columns of client.
          type: string
          example: id1
          nullable: true
        personNameColumn:
          description: The person name as provided in request.
          type: string
          example: Phil Snow
          nullable: true
        firstNameColumn:
          description: The first name of the client.
          type: string
          example: Frederick
          nullable: true
        lastNameColumn:
          description: The last name of the person.
          type: string
          example: Snow
          nullable: true
        middleNameColumn:
          description: The middle name of the client.
          type: string
          example: Philip
          nullable: true
        priorityColumn:
          description: The middle name of the client.
          type: string
          example:
          nullable: true
        salutationColumn:
          description: The salutation of the person.
          type: string
          example: Mr
          nullable: true
        additionalContextColumns:
          description: >
            Comma separated list of any additional column names in the input
            file.  To be used by Managed Service for any unmapped records.
          type: array
          maxItems: 5
          items:
            type: string
          example:
            - Address
            - Phone
            - City
        hasResult:
          description: Whether the result is available.
          type: boolean
          example: true
          nullable: true
        taskAction:
          description: Action status for the Concordance Task process.
          type: string
          example: processfile
          nullable: true
        inputFile:
          description: |
            The input file is posted as a file object in the form.
          type: string
          example: test31.csv
          nullable: true
        entityColumn:
          description: Full name corresponding to the matched entity.
          type: string
          example: FACTSET RESEARCH SYSTEMS INC.
          nullable: true
        status:
          description: >-
            Status of the Concordance Task. If the value is "SUCCESS", you can
            move to the subsequent /entity-decisions endpoint to retrieve the
            results.
          type: string
          nullable: true
          enum:
            - PENDING
            - IN_PROGRESS
            - SUCCESS
            - FAILURE
            - BAD_REQUEST
            - ABORTED
        suffixColumn:
          description: >
            Name of the column in the input file that contains the person's
            suffix.
          type: string
          example: Suffix
          nullable: true
        taskSubmitTime:
          description: Time the Task was submitted in UTC.
          type: string
          format: date-time
          example: 2020-06-24T22:02:21Z
          nullable: true
        unmappedCount:
          description: Number of records with status of UNMAPPED the Input File.
          type: integer
          example: 2
          nullable: true
        tryCount:
          description: Number of tries made so far for the request.
          type: integer
          example: 3
          nullable: true
        decisionRate:
          description: Percentage of mapped entities in the Input File.
          type: number
          format: double
          example: 0.7272727272727273
          nullable: true
        processStartTime:
          description: Process start time in UTC.
          type: string
          format: date-time
          example: 2020-07-03T15:12:06.722000Z
          nullable: true
        processDuration:
          description: Process duration in seconds.
          type: number
          format: double
          example: 1.51603
          nullable: true
        mappedCount:
          description: Number of records with status of MAPPED the Input File.
          type: integer
          example: 8
          nullable: true
        message:
          description: Textual message for the status.
          type: string
          example: Waiting for the input file
          nullable: true
        error:
          type: string
          nullable: true
        errorTitle:
          type: string
          nullable: true
        inputCount:
          description: Number of records in the Input File.
          type: integer
          example: 11
          nullable: true
        indeterminateCount:
          description: Number of records with status of INDETERMINATE the Input File.
          type: integer
          example: 1
          nullable: true
        taskId:
          description: The task identifier
          type: integer
          example: 31
          nullable: true
        taskName:
          description: The task name
          type: string
          example: Analysis1
          nullable: true
        universeId:
          description: The universe identifier
          type: integer
          example: 1
          nullable: true
        universeName:
          description: |
            Full name of the person associated with the `userSerial`.
          type: string
          example: Jane Smith
          nullable: true
        userFullName:
          description: |
            Full name of the person associated with the `userSerial`.
          type: string
          example: Jane Smith
          nullable: true
        userSerial:
          description: |
            user-serial of the person who initiated the people task
          type: string
          example: FDSQAR_C-000000
          nullable: true
    PeopleTaskStatus:
      title: People Task Status
      description: >
        Concordance People Task Status object. Shows the settings and status of
        a taskId and some statistics on the matches.
      type: object
      properties:
        clientIdColumn:
          description: >-
            Name of the column in the input file that contains a unique
            identifier supplied by the user.
          type: string
          example: ClientId
          nullable: true
        decisionRate:
          description: Percentage of mapped entities in the Input File.
          type: integer
          format: double
          example: 0.7272727272727273
          nullable: true
        entityColumn:
          description: |
            Name of the column of the entity.
          type: string
          example: Entity
          nullable: true
        firstNameColumn:
          description: Name of the column in the input file that contains the first name.
          type: string
          example: firstName
          nullable: true
        hasResult:
          description: Whether the result is available.
          type: boolean
          example: true
          nullable: true
        inputCount:
          description: Number of records in the Input File.
          type: integer
          example: 11
          nullable: true
        inputFile:
          description: |
            The input file is posted as a file object in the form.
          type: string
          example: test31.csv
          nullable: true
        lastNameColumn:
          description: |
            Name of the column in the input file that contains the first name.
          type: string
          example: lastName
          nullable: true
        mappedCount:
          description: Number of records with status of MAPPED the Input File.
          type: integer
          example: 8
          nullable: true
        unmappedCount:
          description: Number of records with status of UNMAPPED the Input File.
          type: integer
          example: 2
          nullable: true
        tryCount:
          description: Number of tries made so far for the request.
          type: integer
          example: 3
          nullable: true
        message:
          description: Textual message for the status.
          type: string
          example: Waiting for the input file
          nullable: true
        middleNameColumn:
          description: |
            Name of the column in the input file that contains the middle name.
          type: string
          example: middleName
          nullable: true
        personNameColumn:
          description: |
            Name of the column in the input file that contains the person name.
          type: string
          example: personName
          nullable: true
        priorityColumn:
          description: |
            Name of the column in the input file that contains the priority.
          type: string
          example: Priority
          nullable: true
        processStartTime:
          description: Process start time in UTC.
          type: string
          format: date-time
          example: 2020-07-03T15:12:06.722000Z
          nullable: true
        processDuration:
          description: Process duration in seconds.
          type: number
          format: double
          example: 1.51603
          nullable: true
        error:
          type: string
          nullable: true
        errorTitle:
          type: string
          nullable: true
        indeterminateCount:
          description: Number of records with status of INDETERMINATE the Input File.
          type: integer
          example: 1
          nullable: true
        salutationColumn:
          description: >
            Name of the column in the input file that contains the person's
            salutation.
          type: string
          example: Salutation
          nullable: true
        status:
          description: >-
            Status of the Concordance Task. If the value is "SUCCESS", you can
            move to the subsequent /entity-decisions endpoint to retrieve the
            results.
          type: string
          nullable: true
          enum:
            - PENDING
            - IN_PROGRESS
            - SUCCESS
            - FAILURE
            - BAD_REQUEST
            - ABORTED
        suffixColumn:
          description: >
            Name of the column in the input file that contains the person's
            suffix.
          type: string
          example: Suffix
          nullable: true
        taskAction:
          description: Action status for the Concordance Task process.
          type: string
          example: processfile
          nullable: true
        taskId:
          description: >-
            Identifier denoting a specific Concordance task submitted by the
            user.
          type: integer
          example: 31
          nullable: true
        taskName:
          description: User-defined name for the task used to name the output file.
          type: string
          example: test31
          nullable: true
        taskSubmitTime:
          description: Time the Task was submitted in UTC.
          type: string
          format: date-time
          example: 2020-06-24T22:02:21Z
          nullable: true
        universeId:
          description: The universe identifier
          type: integer
          example: 1
          nullable: true
        universeName:
          description: |
            Full name of the person associated with the `userSerial`.
          type: string
          example: Jane Smith
          nullable: true
        userFullName:
          description: |
            Full name of the person associated with the `userSerial`.
          type: string
          example: Jane Smith
          nullable: true
        userSerial:
          description: user-serial of the person who initiated the entity task.
          type: string
          example: FDSQAR_C-000000
          nullable: true
        additionalContextColumns:
          description: >
            Comma separated list of any additional column names in the input
            file.  To be used by Managed Service for any unmapped records.
          type: array
          maxItems: 5
          items:
            type: string
          example:
            - Address
            - Phone
            - City
    PeopleDecisions:
      title: People Decisions
      description: >
        Concordance People Decisions object. Returned to show the Decision
        reached for each Entity.
      type: object
      properties:
        activeRole:
          description: If the role is active or not of the person.
          type: boolean
          example: true
          nullable: true
        clientEntity:
          description: |
            Name of the entity of the client.
          type: string
          example: Tesla
          nullable: true
        clientId:
          description: >-
            Name of the column in the input file that contains a unique
            identifier supplied by the user.
          type: string
          example: M7
          nullable: true
        clientFirstName:
          description: >-
            First Name provided in the input file which is used in the
            `people-task` endpoint
          type: string
          example: Elon
          nullable: true
        clientLastName:
          description: >-
            Last Name provided in the input file which is used in the
            `people-task` endpoint
          type: string
          example: Musk
          nullable: true
        clientMiddleName:
          description: >-
            Middle Name provided in the input file which is used in the
            `people-task` endpoint
          type: string
          example: Federick
          nullable: true
        clientSalutation:
          description: >-
            Salutation provided in the input file which is used in the
            `people-task` endpoint
          type: string
          example: Mr
          nullable: true
        clientSuffix:
          description: >-
            Suffix provided in the input file which is used in the `people-task`
            endpoint
          type: string
          example: Sir
          nullable: true
        clientPriority:
          description: >-
            Priority provided in the input file which is used in the
            `people-task` endpoint
          type: string
          example: HIGH
          nullable: true
        clientPersonName:
          description: The name provided by the client.
          type: string
          example: Elon Musk
          nullable: true
        clientAdditionalContext:
          description: >
            Any additional context column along with their values in the input
            file or single search.  To be used by Managed Service for any
            unmapped records.
          type: object
          additionalProperties:
            type: string
          example:
            Address: 123 Main St
            Phone: 555-555-5555
            City: New York
        email:
          description: The email address of the client.
          type: string
          example: abc@email.com
          nullable: true
        entity:
          description: Full name corresponding to the matched entity.
          type: string
          example: FACTSET RESEARCH SYSTEMS INC.
          nullable: true
        mapStatus:
          description: |
            Concordance status of the submitted, where - 
              * MAPPED - The requested Entity Name is successfully mapped to a FactSet Entity Id (-E)
              * UNMAPPED - The requested Entity Name is unmapped by FactSet.
              * INDETERMINATE - The requested Entity Name has unable to make a mapping.
          type: string
          enum:
            - MAPPED
            - UNMAPPED
            - INDETERMINATE
          example: MAPPED
          nullable: true
        firstName:
          description: Name of the column in the input file that contains the first name.
          type: string
          example: firstName
          nullable: true
        lastName:
          description: |
            Name of the column in the input file that contains the first name.
          type: string
          example: lastName
          nullable: true
        middleName:
          description: |
            Name of the column in the input file that contains the middle name.
          type: string
          example: middleName
          nullable: true
        personId:
          description: The id of the person.
          type: string
          example: 0DPHLH-E
          nullable: true
        salutation:
          description: >
            The salutation is same as the normal salutation we use .The
            salutation can be Mr, Mrs.The salutation should not be given along
            with personName.
          type: string
          example: Mr
        nameMatchSource:
          description: |
            Type of name that the nameMatchString matched.
          type: string
          example: Presentation Name
          nullable: true
        nameMatchString:
          description: >-
            String on which the Concordance algorithm mapped the submitted
            entity.
          type: string
          example: factset
          nullable: true
        personName:
          description: |
            Name of the column in the input file that contains the person name.
          type: string
          example: personName
          nullable: true
        suffix:
          description: >
            Name of the column in the input file that contains the person's
            suffix.
          type: string
          example: Suffix
          nullable: true
        similarityScore:
          description: >
            Probability of the match being similar to the entity requested as
            determined by the Concordance algorithm. A similarityScore of 1 is
            the highest level of similarity.
          type: number
          format: double
          example: 1
          nullable: true
        matchFlag:
          description: |
            Flag denoting if the row is a match.
          type: boolean
        rowIndex:
          description: Row number for match in the request or input file.
          type: integer
          nullable: true
        taskId:
          description: >-
            Identifier denoting a specific Concordance task submitted by the
            user.
          type: integer
          example: 31
          nullable: true
        title:
          description: The title of the person.
          type: string
          example: Director.
          nullable: true
        universeId:
          description: The universe identifier
          type: integer
          example: 1
          nullable: true
  examples:
    EntityRequests:
      summary: Entity Match Request
      description: Example of a request to find a match for a list of Companies.
      value:
        input:
          - clientId: abc-123
            name: FactSet
            country: US
            state: CT
            url: www.factset.com
          - clientId: def-453
            name: FactSet
            country: DE
        includeEntityType:
          - SUB
        excludeEntityType:
          - PVT
        includeParent: true
    EntityMatches:
      description: Entity Matches
      value:
        data:
          - taskId:
            clientId: id
            clientBbgFigi: BBG009S39JY5
            clientBbgTicker: GOOGL UW
            clientBic: ABXXHKH1
            clientCik: 100331
            clientCountry: US
            clientCrd: 149722
            clientCusip: 02079K305
            clientDuns: 687741991
            clientEin: 953540776
            clientFactsetId: 0013TZ-E
            clientFitch: 47504
            clientGvkey: 107481
            clientGvkeyIid: 107481001
            clientIsin: US02079K305
            clientJcn: 3120001077477
            clientLei: 549300A6K7JX8EX2QZ33
            clientLxid: LX113630
            clientMd: 823736553
            clientName: Amazon
            clientPriority: HIGH
            clientRedCode: 4C933G
            clientRssd: 1139297
            clientSedol: BYZ5YB6
            clientSpr: 301939
            clientState: WA
            clientTicker: GOOGL
            clientTickerExchange: GOOGL-NAS
            clientTickerRegion: GOOGL-US
            clientUkch: CE012494
            clientUrl: www.amazon.com
            clientValoren: 685558
            clientWkn: A0MU9T
            clientAdditionalContext:
              Address: 123 Main St
              Phone: 555-555-5555
              City: New York
            rowIndex: 0
            matchFlag: true
            entityId: 0016YD-E
            entityName: FactSet Research Systems, Inc.
            url: www.factset.com
            mapStatus: MAPPED
            similarityScore: 1
            confidenceScore: 1
            countryCode: US
            countryName: United States
            stateProvinceCode: CT
            stateName: Connecticut
            sicCode: 7374
            entityTypeCode: PUB
            entityTypeDescription: Public Company
            entitySubTypeCode: CP
            locationCity: Norwalk
            regionName: North America
            factsetIndustryCode: 3305
            factsetIndustryName: Data Processing Services
            factsetSectorCode: 3300
            factsetSectorName: Technology Services
            parentName: null,
            parentMatchFlag:
            nameMatchString: factset
            nameMatchSource: Domain Name
    SuccessfulEntityTasks:
      summary: Successful Entity Task
      description: Example of the status of a successful Entity Concordance Task.
      value:
        data:
          - taskId: 31
            taskName: test
            taskAction: processfile
            status: SUCCESS
            inputFile: test_427608.csv
            clientIdColumn: id
            nameColumn: name
            countryColumn: country
            stateColumn: state
            urlColumn: url
            bbgFigiColumn: bbgFigiColumn
            bbgTickerColumn: bbgTickerColumn
            bicColumn: bicColumn
            cikColumn: cikColumn
            crdColumn: crdColumn
            cusipColumn: cusipColumn
            dunsColumn: dunsColumn
            einColumn: einColumn
            factsetIdColumn: factsetIdColumn
            fitchColumn: fitchColumn
            gvkeyColumn: gvkeyColumn
            gvkeyIidColumn: gvkeyIidColumn
            isinColumn: isinColumn
            jcnColumn: jcnColumn
            leiColumn: leiColumn
            lxidColumn: lxidColumn
            mdColumn: mdColumn
            redCodeColumn: redCodeColumn
            rssdColumn: rssdColumn
            sedolColumn: sedolColumn
            sprColumn: sprColumn
            tickerColumn: tickerColumn
            tickerExchangeColumn: tickerExchangeColumn
            tickerRegionColumn: tickerRegionColumn
            ukchColumn: ukchColumn
            valorenColumn: valorenColumn
            wknColumn: wknColumn
            priorityColumn:
            includeEntityType:
              - PUB
            excludeEntityType:
            includeEntitySubType:
              - CP
            excludeEntitySubType:
            hasResult: true
            taskSubmitTime: '2020-12-16T16:22:06Z'
            message:
            inputCount: 4
            mappedCount: 3
            unmappedCount: 1
            indeterminateCount: 0
            processStartTime: '2020-12-16T16:22:09Z'
            processDuration: 38.68899
            tryCount:
            decisionRate: 0.75
            error:
            errorTitle:
            userSerial: FDSQAR_C-000000
            userFullName: Jane Smith
            universeId: 1
            universeName: My Universe
            additionalContextColumns:
              - Address
              - Phone
              - City
    SuccessfulPeopleTasks:
      summary: Successful People Task
      description: Example of the status of a successful People Concordance Task.
      value:
        data:
          - clientColumn: ClientId
            decisionRate: 0.3334
            entityColumn: Company1
            firstNameColumn:
            hasResult: true
            inputCount: 6
            inputFile: test31.csv
            lastNameColumn:
            mappedCount: 5
            middleNameColumn:
            personNameColumn: PersonName
            priorityColumn:
            processDuration: 0.98598
            processStartTime: '2020-07-03T15:12:06.722000+00:00'
            salutationColumn:
            status: SUCCESS
            suffixColumn:
            taskAction: processfile
            taskId: 31
            taskName: test31
            taskSubmitTime: '2020-06-24T22:02:21+00:00'
            userFullName: Jane Smith
            userSerial: FDSQAR_C-000000
            additionalContextColumns:
              - Address
              - Phone
              - City
    PeopleTask:
      value:
        data:
          clientIdColumn: id1,
          entityColumn: Company,
          firstNameColumn:
          hasResult: true
          inputFile: Analysis14
          lastNameColumn:
          middleNameColumn:
          personNameColumn: Bill Gates
          priorityColumn:
          salutationColumn: Mr
          status: PENDING
          suffixColumn:
          taskAction: processfile
          taskId: 354840
          taskName: Analysis14
          taskSubmitTime: '2022-03-01T04:27:32.000+00:00'
          universeId: 735
          universeName: Jane Smith
          userSerial: FDSQAR_C-000000
          additionalContextColumns:
            - Address
            - Phone
            - City
    PendingTask:
      summary: Status pending input file
      description: Example of the status of a Task pending input file.
      value:
        data:
          taskId: 31
          taskName: test
          taskAction: processfile
          status: PENDING
          inputFile: test_427608.csv
          bbgFigiColumn: bbgFigiColumn
          bbgTickerColumn: bbgTickerColumn
          bicColumn: bicColumn
          cikColumn: cikColumn
          crdColumn: crdColumn
          cusipColumn: cusipColumn
          dunsColumn: dunsColumn
          einColumn: einColumn
          factsetIdColumn: factsetIdColumn
          fitchColumn: fitchColumn
          gvkeyColumn: gvkeyColumn
          gvkeyIidColumn: gvkeyIidColumn
          isinColumn: isinColumn
          jcnColumn: jcnColumn
          leiColumn: leiColumn
          lxidColumn: lxidColumn
          mdColumn: mdColumn
          redCodeColumn: redCodeColumn
          rssdColumn: rssdColumn
          sedolColumn: sedolColumn
          sprColumn: sprColumn
          tickerColumn: tickerColumn
          tickerExchangeColumn: tickerExchangeColumn
          tickerRegionColumn: tickerRegionColumn
          ukchColumn: ukchColumn
          valorenColumn: valorenColumn
          wknColumn: wknColumn
          clientIdColumn: id
          nameColumn: name
          countryColumn: country
          stateColumn: state
          urlColumn: url
          includeEntityType:
            - PUB
          excludeEntityType:
          includeEntitySubType:
            - CP
          excludeEntitySubType:
          hasResult: false
          taskSubmitTime: '2020-12-16T16:22:06Z'
          message:
          inputCount:
          mappedCount:
          unmappedCount:
          indeterminateCount:
          priorityColumn:
          processStartTime:
          processDuration:
          tryCount:
          decisionRate:
          error:
          errorTitle:
          userSerial: FDSQAR_C-000000
          userFullName: Jane Smith
          universeId: 1
          universeName: My Universe
          additionalContextColumns:
            - Address
            - Phone
            - City
    PendingTasks:
      summary: Status pending input file
      description: Example of the status of a Task pending input file.
      value:
        data:
          - taskId: 31
            taskName: test
            taskAction: processfile
            status: PENDING
            inputFile: test_427608.csv
            clientIdColumn: id
            nameColumn: name
            countryColumn: country
            priorityColumn:
            stateColumn: state
            urlColumn: url
            includeEntityType:
              - PUB
            excludeEntityType:
            includeEntitySubType:
              - CP
            excludeEntitySubType:
            hasResult: false
            taskSubmitTime: '2020-12-16T16:22:06Z'
            message:
            inputCount:
            mappedCount:
            unmappedCount:
            indeterminateCount:
            processStartTime:
            processDuration:
            tryCount:
            decisionRate:
            error:
            errorTitle:
            userSerial: FDSQAR_C-000000
            userFullName: Jane Smith
            universeId: 1
            universeName: My Universe
            additionalContextColumns:
              - Address
              - Phone
              - City
    PendingTask1:
      summary: Status pending input file
      description: Example of the status of a Task pending input file.
      value:
        data:
          - clientColumn: ClientId
            decisionRate:
            entityColumn: Entity
            error:
            errorTitle:
            firstNameColumn: firstName
            hasResult": true
            indeterminateCount: 1
            inputCount: 11
            inputFile: test31.csv
            lastNameColumn: Lastname
            mappedCount: 8
            message: Waiting for the input file
            middleNameColumn: Middlename
            personNameColumn: PersonName
            priorityColumn: Priority
            processDuration: 1.51603
            processStartTime: '2020-07-03T15:12:06.722000+00:00'
            salutationColumn: Salutation
            status: PENDING
            suffixColumn: Suffix
            taskAction: processfile
            taskId: 31
            taskName: test31
            taskSubmitTime: '2020-06-24T22:02:21+00:00'
            tryCount: 3
            universeId: 1
            universeName: My Universe
            unmappedCount: 2
            userFullName: Jane Smith
            userSerial: FDSQAR_C-000000
            additionalContextColumns:
              - Address
              - Phone
              - City
    BadTasks:
      summary: Status for bad request
      description: Example of the status of a Task with a bad request.
      value:
        data:
          - taskId: 31
            taskName: test
            taskAction: processfile
            status: BAD_REQUEST
            inputFile: test_427608.csv
            clientIdColumn: id
            nameColumn: name
            countryColumn: country
            stateColumn: state
            urlColumn: url
            includeEntityType:
              - PUB
            excludeEntityType:
            includeEntitySubType:
              - CP
            excludeEntitySubType:
            hasResult: false
            taskSubmitTime: '2020-12-17T20:43:42Z'
            message:
            inputCount:
            mappedCount:
            unmappedCount:
            indeterminateCount:
            processStartTime: '2020-12-17T20:44:00Z'
            processDuration: 0
            tryCount:
            decisionRate:
            error: >-
              The Name column "name", passed as parameter, does not exist in the
              input file.
            errorTitle: Wrong parameter
            userSerial: FDSQAR_C-000000
            userFullName: Jane Smith
            universeId: 1
            universeName: My Universe
            additionalContextColumns:
              - Address
              - Phone
              - City
    BadTasks1:
      summary: Status for bad request
      description: Example of the status of a Task with a bad request.
      value:
        data:
          clientColumn: ClientId
          decisionRate:
          entityColumn: Entity
          error:
          errorTitle:
          firstNameColumn: firstName
          hasResult": true
          indeterminateCount: 1
          inputCount: 11
          inputFile: test31.csv
          lastNameColumn: Lastname
          mappedCount: 8
          message: Waiting for the input file
          middleNameColumn: Middlename
          personNameColumn: PersonName
          priorityColumn: Priority
          processDuration: 1.51603
          processStartTime: '2020-07-03T15:12:06.722000+00:00'
          salutationColumn: Salutation
          status: PENDING
          suffixColumn: Suffix
          taskAction: processfile
          taskId: 31
          taskName: test31
          taskSubmitTime: '2020-06-24T22:02:21+00:00'
          tryCount: 3
          universeId: 1
          universeName: My Universe
          unmappedCount: 2
          userFullName: Jane Smith
          userSerial: FDSQAR_C-000000
          additionalContextColumns:
            - Address
            - Phone
            - City
    FailedTasks:
      summary: Status for failed request
      description: Example of the status of a Task with a failed request.
      value:
        data:
          - taskId: 31
            taskName: test
            taskAction: processfile
            status: FAILURE
            inputFile: test_427608.csv
            clientIdColumn: id
            nameColumn: name
            countryColumn: country
            stateColumn: state
            urlColumn: url
            includeEntityType:
              - PUB
            excludeEntityType:
            includeEntitySubType:
              - CP
            excludeEntitySubType:
            hasResult: false
            taskSubmitTime: '2020-12-17T20:43:42Z'
            message:
            inputCount:
            mappedCount:
            unmappedCount:
            indeterminateCount:
            processStartTime: '2020-12-17T20:44:00Z'
            processDuration: 0
            tryCount:
            decisionRate:
            error: different refererence used by concordance service
            errorTitle: compute_candidates
            userSerial: FDSQAR_C-000000
            userFullName: Jane Smith
            universeId: 1
            universeName: My Universe
            additionalContextColumns:
              - Address
              - Phone
              - City
    FailedTasks1:
      summary: Status for failed request
      description: Example of the status of a Task with a failed request.
      value:
        data:
          clientColumn: ClientId
          decisionRate:
          entityColumn: Entity
          error:
          errorTitle:
          firstNameColumn: firstName
          hasResult": false
          indeterminateCount: 1
          inputCount: 11
          inputFile: test31.csv
          lastNameColumn: Lastname
          mappedCount:
          message: Waiting for the input file
          middleNameColumn: Middlename
          personNameColumn: PersonName
          priorityColumn: Priority
          processDuration: 1.51603
          processStartTime: '2020-07-03T15:12:06.722000+00:00'
          salutationColumn: Salutation
          status: PENDING
          suffixColumn: Suffix
          taskAction: processfile
          taskId: 31
          taskName: test31
          taskSubmitTime: '2020-06-24T22:02:21+00:00'
          tryCount: 3
          universeId: 1
          universeName: My Universe
          unmappedCount: 2
          userFullName: Jane Smith
          userSerial: FDSQAR_C-000000
          additionalContextColumns:
            - Address
            - Phone
            - City
    EntityDecisionsFile:
      description: An Entity Concordance Task Decision File.
      value: >
        rowIndex,clientId,requestName,requestCountry,name,requestUrl,entityType,mapStatus,similarityScore,confidenceScore

        0,FDS-US,FactSet,"FactSet Research Systems,
        Inc.",US,www.factset.com,PUB,MATCHED,1.0,1.0

        1,FDS-DE,FactSet,FactSet GmbH,DE,,SUB,MATCHED,1.0,1.0
    EntityDecisions:
      description: Entity Decisions
      value:
        data:
          - taskId: 427749
            clientBbgFigi: BBG009S39JY5
            clientBbgTicker: GOOGL UW
            clientBic: ABXXHKH1
            clientCik: 100331
            clientCountry: US
            clientCrd: 149722
            clientCusip: 02079K305
            clientDuns: 687741991
            clientEin: 953540776
            clientFactsetId: 0013TZ-E
            clientFitch: 47504
            clientGvkey: 107481
            clientGvkeyIid: 107481001
            clientId: abc-123
            clientIsin: US02079K305
            clientJcn: 3120001077477
            clientLei: 549300A6K7JX8EX2QZ33
            clientLxid: LX113630
            clientMd: 823736553
            clientName: Amazon
            clientPriority: HIGH
            clientRedCode: 4C933G
            clientRssd: 1139297
            clientSedol: BYZ5YB6
            clientSpr: 301939
            clientState: WA
            clientTicker: GOOGL
            clientTickerExchange: GOOGL-NAS
            clientTickerRegion: GOOGL-US
            clientUkch: CE012494
            clientUrl: www.amazon.com
            clientValoren: 685558
            clientWkn: A0MU9T
            confidenceScore: 1
            countryCode: US
            countryName: United States
            entityId: 0016YD-E
            entityName: FactSet Research Systems, Inc.
            entitySubTypeCode: CP
            entityTypeCode: PUB
            entityTypeDescription: Public Company
            factsetIndustryCode: 3305
            factsetIndustryName: Data Processing Services
            factsetSectorCode: 3300
            factsetSectorName: Technology Services
            locationCity: Norwalk
            mapStatus: MAPPED
            matchFlag:
            nameMatchSource: Domain Name
            nameMatchString: factset
            parentMatchFlag:
            parentName: null,
            regionName: North America
            rowIndex: 0
            sicCode: 7374
            similarityScore: 1
            stateName: Connecticut
            stateProvinceCode: CT
            url: www.factset.com
            clientAdditionalContext:
              Address: 123 Main St
              Phone: 555-555-5555
              City: New York
    NotFound:
      description: 404 - Not Found
      value:
        status: Not Found
        timestamp: 2019-11-01T11:09:41.918000Z
        path: /factset-concordance/v2/fakeendpoint
        message: '''/factset-concordance/v2/fake-endpoint'' is not a valid endpoint'
        subErrors:
    EntityUniverse:
      description: Entity Universe response from v2 endpoint
      value:
        data:
          - entityId: 00345-E
            entityName: FactSet Inc.
            clientId: abc-123
            clientIsin: US02079K305
            clientName: factset
            clientSedol: 2329770
            clientCountry: us
            clientState: ct
            clientUrl: www.factset.com
            createdTime: 2020-09-04T20:14:13.123000Z
            updatedTime: 2020-10-04T20:14:13.123000Z
            mapStatus: MAPPED
            universeId: 1
            clientAdditionalContext:
              Address: 123 Main St
              Phone: 555-555-5555
              City: New York
          - entityId:
            entityName:
            clientId: def-456
            clientIsin: US0378331005
            clientName: apple
            clientSedol: 2046251
            clientCountry: us
            clientState: ca
            clientUrl: www.apple.com
            createdTime: 2020-07-04T20:14:13.123000Z
            updatedTime: 2020-08-04T20:14:13.123000Z
            mapStatus: UNMAPPED
            universeId: 1
            clientAdditionalContext:
              Address: 123 Main St
              Phone: 555-555-5555
              City: New York
    PeopleUniverse:
      description: People Universe response from v2 endpoint
      value:
        data:
          - clientEntity: Microsoft
            clientFirstName: William
            clientId: BGA-123
            clientLastName: Gates
            clientMiddleName: Henry
            clientPersonName: Bill Gates
            clientPriority: HIGH
            clientSalutation: Mr
            clientSuffix: III
            createdTime: 2020-06-24T22:02:21Z
            mapStatus: MAPPED
            personId: 00118X-E
            personName: GATES WILLIAM H III
            universeId: 1
            updatedTime: 2020-06-24T22:02:21Z
            clientAdditionalContext:
              Address: 123 Main St
              Phone: 555-555-5555
              City: New York
          - clientEntity: Microsoft
            clientFirstName: William
            clientId: BGA-123
            clientLastName: Gates
            clientMiddleName: Henry
            clientPersonName: Bill Gates
            clientPriority: HIGH
            clientSalutation: Mr
            clientSuffix: III
            createdTime: 2020-06-24T22:02:21Z
            mapStatus: MAPPED
            personId: 00118X-E
            personName: GATES WILLIAM H III
            universeId: 1
            updatedTime: 2020-06-24T22:02:21Z
            clientAdditionalContext:
              Address: 123 Main St
              Phone: 555-555-5555
              City: New York
    EntityResponse:
      description: Entity Response
      value:
        data:
          entityId: 00345-E
          entityName: FactSet Inc.
          clientId: abc-123
          clientIsin: US02079K305
          clientName: factset
          clientSedol: BYZ5YB6
          clientCountry: US
          clientState: CT
          clientUrl: www.factset.com
          createdTime: 2020:09:04T20:14:13.123
          updatedTime: 2020:10:04T20:14:13.123
          mapStatus: MAPPED
          universeId: 1
          clientAdditionalContext:
            Address: 123 Main St
            Phone: 555-555-5555
            City: New York
    EntityMappingRequest:
      description: Entity Mapping Request
      value:
        clientId: abc-123
        entityId: 0016YD-E
        clientName: FactSet
        clientCountry: US
        clientState: CT
        clientUrl: www.factset.com
    PeopleResponse:
      description: People Response
      value:
        data:
          clientEntity: Microsoft
          clientFirstName: William
          clientId: BGA-123
          clientLastName: Gates
          clientMiddleName: Henry
          clientPersonName: Bill Gates
          clientPriority: HIGH
          clientSalutation: Mr
          clientSuffix: III
          clientAdditionalContext:
            Address: 123 Main St
            Phone: 555-555-5555
            City: New York
          createdTime: 2020:09:04T20:14:13.123
          mapStatus: MAPPED
          personId: 00118X-E
          personName: GATES WILLIAM H III
          universeId: 1
          updatedTime: 2020:09:04T20:14:13.123
    PeopleMappingRequest:
      description: People Mapping Request
      value:
        clientEntity: Microsoft
        clientFirstName: William
        clientId: BGA-123
        clientLastName: Gates
        clientMiddleName: Henry
        clientPriority: HIGH
        clientSalutation: Mr
        clientSuffix: III
        personId: 00118X-E
        universeId: 1
    EntityUniverseStatsResponse:
      description: |
        Statistics on a universe
      value:
        data:
          totalCount: 10
          unmappedCount: 1
          mappedCount: 8
          indeterminateCount: 1
          universeId: 1
    PeopleMatches:
      description: People Matches
      value:
        data:
          - activeRole: true,
            clientEntity: Microsoft,
            clientPersonName: Phil Snow
            entity: FACTSET RESEARCH SYSTEMS INC
            firstName: Frederick
            lastName: Snow
            mapStatus: MAPPED
            matchFlag: true
            middleName: Philip
            nameMatchSource: Presentation Name
            nameMatchString: philip snow
            personId: 0DPHLH-E
            personName: SNOW FREDERICK PHILIP
            rowIndex: 0
            similarityScore: 1
            universeId: 1
            clientAdditionalContext:
              Address: 123 Main St
              Phone: 555-555-5555
              City: New York
    PeopleDecisions:
      description: People Decisions
      value:
        data:
          activeRole: false
          clientEntity: Tesla
          clientId: M7
          clientPersonName: Elon Musk
          email: ''
          entity: TESLA INC
          firstName: Elon
          lastName: Musk
          mapStatus: MAPPED
          middleName: Reeve
          nameMatchSource: Institutional Affliation
          nameMatchString: Elon Reeve Musk
          personId: 05H8B8-E
          personName: MUSK ELON REEVE
          rowIndex: 0
          similarityScore: 1
          suffix: ''
          taskId: 353453
          title: Technoking of Tesla
          clientAdditionalContext:
            Address: 123 Main St
            Phone: 555-555-5555
            City: New York
    badRequestRequiredParameter:
      summary: Bad Request - Required Parameter Missing
      description: >-
        This error message occurs when the request does not include the required
        parameters. Required parameters are indicated with a red asterisks
        symbol in the specification file.
      value:
        status: Bad Request
        timestamp: '2020-06-30 13:22:09.053'
        path: /factset-concordance/v2/{endpoint}
        message: The parameter 'name' is required and may not be empty.
        subErrors:
    badRequestInvalidParameters:
      summary: Bad Request - Passing Invalid Parameter
      description: >-
        This error message occurs when a request parameter is not recognized by
        the service. Please revise your request to include only the parameters
        listed in the specification. Typical errors are spelling mistakes and
        use of improper casing.
      value:
        status: Bad Request
        timestamp: '2020-07-23 11:03:40.765'
        path: /factset-concordance/v2/{endpoint}
        message: >-
          Invalid Parameter (s): fakeParameterName1 fakeParameterName2. Please
          modify your request to use parameters outlined in the specification
          for this endpoint.
        subErrors:
    badRequestMalformedJSON:
      summary: Bad Request - Malformed JSON Request
      description: >-
        This error may be returned when the request body is specified as JSON.
        But is not in proper JSON format.
      value:
        status: Bad Request
        timestamp: '2020-07-02 11:59:09.649'
        path: /factset-concordance/v2/{endpoint}
        message: Malformed JSON Request
        subErrors:
    badRequestReadTimeout:
      summary: Bad Request - Read Timeout
      description: This error may be returned if it takes more than 29 seconds to complete.
      value:
        status: Bad Request
        timestamp: '2020-07-02 16:18:38.949'
        path: /factset-concordance/v2/{endpoint}
        message: The request took too long. Try again with a smaller request.
        subErrors:
    unauthenticated:
      summary: User Authentication Failed
      description: >-
        This occurs when a user is not properly authenticated or recognized by
        the service. Please double check the USERNAME-SERIAL and API-Key used to
        request and ensure you are within the IP range specified for the Key.
        Report Issue under 401 error for help with troubleshooting.
      value:
        status: User Authentication Failed
        timestamp: '2020-07-02 16:08:07.945'
        path: /factset-concordance/v2/{endpoint}
        message: User Authentication Failed.
        subErrors:
    forbidden:
      summary: Forbidden
      description: >-
        The USERNAME-SERIAL attempted to request the endpoint which is not
        authorized to access. The request was a legal request, but the server is
        refusing to respond. Please reach out to FactSet Account Team for
        assistance with authorization.
      value:
        status: Forbidden
        timestamp: '2020-07-02 17:21:52.197'
        path: /factset-concordance/v2/{endpoint}
        message: >-
          User is not authorized for the id requested, please reach out to
          FactSet for support
        subErrors:
    unsupportedMediaType:
      summary: Unsupported Media Type
      description: >-
        This bad request occurs when the media type passed in the request is not
        supported. Currently the APIs only support 'application/json'.
      value:
        status: Unsupported Media Type
        timestamp: '2020-07-02 09:42:27.237'
        path: /factset-concordance/v2/{endpoint}
        message: >-
          text/html media type is not supported. Supported media types are
          application/json.
        subErrors:
    notWritable:
      summary: Internal Server Error - Not Writable
      description: >-
        This error may be returned when the server encounters an error writing
        the JSON response.
      value:
        status: Internal Server Error
        timestamp: '2020-07-02 09:48:29.18'
        path: /factset-concordance/v2/{endpoint}
        message: Error writing JSON output
        subErrors:
    generalException:
      summary: Internal Server Error - General Exception
      description: >-
        This is the most general error that can be returned to by the service.
        Please `Report Issue` to FactSet.
      value:
        status: Internal Server Error
        timestamp: '2020-07-02 10:36:01.944'
        path: /factset-concordance/v2/{endpoint}
        message: Unexpected error
        subErrors: