Clarivate Integration API

openapi: 3.2.0
info:
  description: This API supports rich searching across the Web of Science based on your subscription to retrieve item-level metadata, including times cited counts and contributor addresses/affiliations.
  version: 1.0.0-oas3
  title: Web of Science API Expanded Integration API
servers:
- url: https://api.clarivate.com/api/wos
security:
- key: []
tags:
- name: Integration
  description: Supports integration and data supplement activities.
paths:
  /id/{uniqueId}:
    get:
      tags:
      - Integration
      summary: Find record(s) by specific id
      description: This operation returns a record identified by a unique identifier. You may specify multiple identifiers in a single request by separating each ID with a comma.
      parameters:
      - name: databaseId
        in: query
        description: Database to search. WOK represents all databases.
        required: true
        schema:
          type: string
          enum:
          - WOS
          - BCI
          - BIOABS
          - BIOSIS
          - CABI
          - CCC
          - CSCD
          - DCI
          - DIIDW
          - FSTA
          - GRANTS
          - INSPEC
          - MEDLINE
          - PPRN
          - PQDT
          - RC
          - SCIELO
          - WOK
          - ZOOREC
      - name: lang
        in: query
        description: 'Language of search. This element can take only one value: en for English. If no language is specified, English is passed by default.'
        required: false
        schema:
          type: string
      - name: uniqueId
        in: path
        description: 'Primary item(s) id to be searched, ex: WOS:000270372400005. Cannot be null or an empty string. Multiple values are separated by comma.'
        required: true
        schema:
          type: string
          example: WOS:000270372400005
      - name: viewField
        in: query
        description: 'Parameter to limit records to selected fields. Because many fields are uniquely identified by a combination of element and attribute, you may not be able to limit record content to a precise degree. For example, the viewField parameter ''titles'' will always return document titles, publication names (both full and abbreviated), and book titles. You cannot limit retrieval to only document (item) titles or only publication (source) titles because item and source are attribute values, not elements. You cannot include attributes in viewField parameters. Collection name and field name(s) separated by ''+''  or '' '' ex: WOS+titles+addresses, where titles and addresses represent fields.If collection name is missing, the database id will be used, e.g. databaseId=WOS&viewfield=title+addresses is equivalent to databaseId=WOS&viewfield=WOS+title+addresses.'
        required: false
        schema:
          type: string
        examples:
          Search0:
            value: ''
            summary: All
          Search1:
            value: pub_info
            summary: View Publication Information
          Search2:
            value: titles+addresses
            summary: View Document Title and Author Address
          Search3:
            value: doctypes+keywords
            summary: View Document Type and Author Keywords
          Search4:
            value: conferences
            summary: View Conferences
          Search5:
            value: contributor
            summary: View ResearcherID or ORCID
      - name: optionView
        in: query
        description: "Document detail:\n  * `FR` - Retrieves all metadata of the document (also known as FullRecord)\n  * `SR` - Retrieves a short version of the document that would not count against the quota.\n              The response fields are similar to the [Web of Science Starter API](https://developer.clarivate.com/apis/wos-starter) fields.\n  * `FS` - Custom Field Selection - must be combined with query parameter `viewField`. It is automatically selected if `viewField` is used.\n"
        schema:
          type: string
          enum:
          - FR
          - SR
          - FS
          default: FR
      - name: optionOther
        in: query
        description: 'Other option(s) of result representation. HL and On/Off separated by ''+''  or '' '' where HL=HighLight: ex. HL+On.'
        required: false
        schema:
          type: string
      - name: links
        in: query
        description: Flag to return gateway links(Source and Citing) for each record returned in response. Default is false
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WosSearchResponse'
            application/json(ShortRecord):
              schema:
                $ref: '#/components/schemas/WosShortSearchResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/WosSearchResponseXML'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorMessage'
            application/xml:
              schema:
                $ref: '#/components/schemas/errorMessage'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorMessage'
            application/xml:
              schema:
                $ref: '#/components/schemas/errorMessage'
        '429':
          description: Throttle error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorMessage'
            application/xml:
              schema:
                $ref: '#/components/schemas/errorMessage'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorMessage'
            application/xml:
              schema:
                $ref: '#/components/schemas/errorMessage'
      operationId: getIdByUniqueId
      x-operation-id-source: derived
  /recordids/{queryId}:
    get:
      tags:
      - Integration
      summary: Return IDs of records for a given query by a query identifier
      description: This operation returns unique identifiers of records related to a query identifier. No other full record details are returned. This list of identifiers can be compared to an existing set of IDs (eg. supporting duplicate checks) and then be queried using /id/{uniqueId} to return the appropriate metadata.
      parameters:
      - name: queryId
        in: path
        description: Query identifier for which to return results.
        required: true
        schema:
          type: integer
          example: 1
      - name: count
        in: query
        description: Number of record identifiers to return, number between 1-100.
        required: false
        schema:
          type: integer
          default: 10
          example: 10
      - name: firstRecord
        in: query
        description: Specific record, if any within the result set to return. number between 1-100,000.
        required: false
        schema:
          type: integer
          default: 1
          example: 1
      - name: sortField
        in: query
        description: 'Order by field(s). Field name and order by clause separated by ''+''  or '' '', use A for ASC and D for DESC, ex: PY+D. Multiple values are separated by comma.'
        required: false
        schema:
          type: string
        examples:
          LoadDate:
            value: LD+D
            summary: Load Date (Descending)
          LoadDate Asc:
            value: LD+A
            summary: Load Date (Ascending)
          Author:
            value: AU+D
            summary: Author (Descending)
          Author Asc:
            value: AU+A
            summary: Author (Ascending)
          CTitle:
            value: CF+D
            summary: Conference Title (Descending)
          CTitle Asc:
            value: CF+A
            summary: Conference Title (Ascending)
          CitedYear:
            value: CY+D
            summary: Cited Year (Descending)
          CitedYear Asc:
            value: CY+A
            summary: Cited Year (Ascending)
          LTCited:
            value: LC+D
            summary: Local Times Cited (Descending)
          LTCited Asc:
            value: LC+A
            summary: Local Times Cited (Ascending)
          Page PG:
            value: PG+D
            summary: Page (Descending)
          Page Asc:
            value: PG+A
            summary: Page (Ascending)
          PYear:
            value: PY+D
            summary: Publication Year (Descending)
          PYear Asc:
            value: PY+A
            summary: Publication Year (Ascending)
          Relevance:
            value: RS+D
            summary: Relevance (Descending)
          Source SO:
            value: SO+D
            summary: Source (Descending)
          Source SO Asc:
            value: SO+A
            summary: Source (Ascending)
          TimesCited:
            value: TC+D
            summary: Times Cited (Descending)
          TimesCited Asc:
            value: TC+A
            summary: Times Cited (Ascending)
          Volume VL:
            value: VL+D
            summary: Volume (Descending)
          Volume VL Asc:
            value: VL+A
            summary: Volume (Ascending)
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
            application/xml:
              schema:
                xml:
                  name: response
                  namespace: http://www.isinet.com/xrpc42
                type: object
                properties:
                  list:
                    type: object
                    properties:
                      val:
                        type: array
                        items:
                          type: string
                          example: WOS:000515009500001
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorMessage'
            application/xml:
              schema:
                $ref: '#/components/schemas/errorMessage'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorMessage'
            application/xml:
              schema:
                $ref: '#/components/schemas/errorMessage'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorMessage'
            application/xml:
              schema:
                $ref: '#/components/schemas/errorMessage'
      operationId: getRecordidsByQueryId
      x-operation-id-source: derived
components:
  schemas:
    WosSearchResponseXML:
      type: object
      xml:
        name: response
        namespace: http://www.isinet.com/xrpc42
      properties:
        map:
          type: object
          properties:
            map:
              type: object
              properties:
                name:
                  type: string
                  example: Data
                  xml:
                    attribute: true
                val:
                  type: object
                  properties:
                    name:
                      type: string
                      example: Records
                      xml:
                        attribute: true
                    records:
                      type: object
                      properties:
                        REC:
                          type: array
                          items:
                            $ref: '#/components/schemas/WosRecordXML'
        QueryResult:
          $ref: '#/components/schemas/QueryResult'
    errorMessage:
      type: object
      xml:
        name: error
        namespace: http://www.isinet.com/xrpc42
      properties:
        code:
          type: string
          description: Error Code
        message:
          type: string
          description: Error Message
        id:
          type: string
          description: Request Id
    WosSearchResponse:
      type: object
      properties:
        Data:
          type: object
          properties:
            Records:
              type: object
              properties:
                records:
                  type: object
                  properties:
                    REC:
                      type: array
                      items:
                        $ref: '#/components/schemas/WosRecord'
        QueryResult:
          $ref: '#/components/schemas/QueryResult'
    QueryResult:
      type: object
      properties:
        QueryID:
          type: string
        RecordsSearched:
          type: integer
        RecordsFound:
          type: integer
    WosRecordXML:
      type: object
      required:
      - UID
      - static_data
      - r_id_disclaimer
      - dynamic_data
      properties:
        UID:
          type: string
          example: WOS:001020694100001
        static_data:
          type: object
          properties:
            summary:
              type: object
              properties:
                EWUID:
                  type: object
                  properties:
                    WUID:
                      type: object
                      properties:
                        coll_id:
                          type: string
                          example: WOS
                          xml:
                            attribute: true
                    edition:
                      type: array
                      items:
                        type: object
                        properties:
                          value:
                            type: string
                            example: WOS.SSCI
                            xml:
                              attribute: true
                pub_info:
                  type: object
                  properties:
                    coverdate:
                      type: string
                      example: OCT 2019
                      xml:
                        attribute: true
                    vol:
                      type: integer
                      example: 203
                      xml:
                        attribute: true
                    journal_oas_gold:
                      type: string
                      example: N
                      xml:
                        attribute: true
                    has_citation_context:
                      type: string
                      example: Y
                      xml:
                        attribute: true
                    pubyear:
                      type: integer
                      example: 2019
                      xml:
                        attribute: true
                    issue:
                      type: integer
                      example: 27
                      xml:
                        attribute: true
                    special_issue:
                      type: string
                      example: SI
                      xml:
                        attribute: true
                    sortdate:
                      type: string
                      example: '2019-08-21'
                      xml:
                        attribute: true
                    has_abstract:
                      type: string
                      example: N
                      xml:
                        attribute: true
                    pubmonth:
                      type: string
                      example: OCT
                      xml:
                        attribute: true
                    pubtype:
                      type: string
                      example: Journal
                      xml:
                        attribute: true
                    early_access_month:
                      type: integer
                      example: 08
                      xml:
                        attribute: true
                    early_access_date:
                      type: string
                      example: AUG 2019
                      xml:
                        attribute: true
                    early_access_year:
                      type: integer
                      xml:
                        attribute: true
                    page:
                      type: object
                      properties:
                        end:
                          type: integer
                          example: 11
                          xml:
                            attribute: true
                        begin:
                          type: integer
                          example: 9
                          xml:
                            attribute: true
                        page_count:
                          type: integer
                          example: 2
                          xml:
                            attribute: true
                titles:
                  type: object
                  properties:
                    count:
                      type: integer
                      example: 6
                      xml:
                        attribute: true
                    title:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                            example: source
                            xml:
                              attribute: true
                names:
                  type: object
                  properties:
                    count:
                      type: integer
                      example: 1
                      xml:
                        attribute: true
                    name:
                      type: array
                      items:
                        type: object
                        properties:
                          seq_no:
                            type: integer
                            example: 1
                            xml:
                              attribute: true
                          role:
                            type: string
                            example: author
                            xml:
                              attribute: true
                          claim_status:
                            type: boolean
                            example: false
                            xml:
                              attribute: true
                          r_id:
                            type: string
                            example: CFP-5648-2022
                            xml:
                              attribute: true
                          daisng_id:
                            type: integer
                            example: 5206054
                            xml:
                              attribute: true
                          orcid_id:
                            type: string
                            example: 0000-0001-9349-1715
                            xml:
                              attribute: true
                          addr_no:
                            type: string
                            example: 1 2 8
                            xml:
                              attribute: true
                          reprint:
                            type: string
                            example: Y
                            xml:
                              attribute: true
                          full_name:
                            type: string
                            example: Lauridsen, S. V.
                          first_name:
                            type: string
                            example: S. V.
                          last_name:
                            type: string
                            example: Lauridsen
                          display_name:
                            type: string
                            example: Lauridsen, S. V.
                          wos_standard:
                            type: string
                            example: Lauridsen, SV
                          noncore_startyear:
                            type: integer
                            example: 2011
                          noncore_endyear:
                            type: integer
                            example: 2023
                          data-item-ids:
                            type: object
                            properties:
                              data-item-id:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    example: person
                                    xml:
                                      attribute: true
                          preferred_name:
                            type: object
                            properties:
                              full_name:
                                type: string
                              last_name:
                                type: string
                              middle_name:
                                type: string
                              first_name:
                                type: string
                doctypes:
                  type: object
                  properties:
                    doctype:
                      type: array
                      items:
                        type: string
                    count:
                      type: integer
                      example: 2
                      xml:
                        attribute: true
                publishers:
                  type: object
                  properties:
                    publisher:
                      type: object
                      properties:
                        names:
                          type: object
                          properties:
                            count:
                              type: integer
                              example: 1
                              xml:
                                attribute: true
                            name:
                              type: object
                              properties:
                                seq_no:
                                  type: integer
                                  example: 1
                                  xml:
                                    attribute: true
                                role:
                                  type: string
                                  example: publisher
                                  xml:
                                    attribute: true
                                full_name:
                                  type: string
                                  example: TAYLOR & FRANCIS LTD
                                unified_name:
                                  type: string
                                  example: Taylor & Francis
                                addr_no:
                                  type: integer
                                  example: 1
                                  xml:
                                    attribute: true
                                display_name:
                                  type: string
                                  example: TAYLOR & FRANCIS LTD
                        address_spec:
                          type: object
                          properties:
                            city:
                              type: string
                              example: ABINGDON
                            addr_no:
                              type: integer
                              example: 1
                              xml:
                                attribute: true
                            full_address:
                              type: string
                              example: 2-4 PARK SQUARE, MILTON PARK, ABINGDON OR14 4RN, OXON, ENGLAND
                            url_spec:
                              type: object
                              properties:
                                url:
                                  type: string
            fullrecord_metadata:
              type: object
              properties:
                languages:
                  type: object
                  properties:
                    count:
                      type: integer
                      example: 1
                      xml:
                        attribute: true
                    language:
                      type: object
                      properties:
                        type:
                          type: string
                          example: primary
                          xml:
                            attribute: true
                normalized_languages:
                  type: object
                  properties:
                    count:
                      type: integer
                      example: 1
                      xml:
                        attribute: true
                    language:
                      type: object
                      properties:
                        type:
                          type: string
                          example: primary
                          xml:
                            attribute: true
                normalized_doctypes:
                  type: object
                  properties:
                    doctype:
                      type: array
                      items:
                        type: string
                      example:
                      - Review
                      - Early Access
                    count:
                      type: integer
                      example: 2
                      xml:
                        attribute: true
                addresses:
                  type: object
                  properties:
                    count:
                      type: integer
                      example: 8
                      xml:
                        attribute: true
                    address_name:
                      type: array
                      items:
                        type: object
                        properties:
                          address_spec:
                            type: object
                            properties:
                              addr_no:
                                type: integer
                                example: 1
                                xml:
                                  attribute: true
                              zip:
                                type: object
                                properties:
                                  location:
                                    type: string
                                    example: AP
                                    xml:
                                      attribute: true
                              country:
                                type: string
                                example: USA
                              city:
                                type: string
                                example: NEW YORK
                              organizations:
                                type: object
                                properties:
                                  organization:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        pref:
                                          type: string
                                          xml:
                                            attribute: true
                                  count:
                                    type: integer
                                    example: 2
                                    xml:
                                      attribute: true
                              full_address:
                                type: string
                              state:
                                type: string
                              suborganizations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    count:
                                      type: integer
                                      example: 1
                                      xml:
                                        attribute: true
                                    suborganization:
                                      oneOf:
                                      - type: string
                                      - type: array
                                      example: Parker Inst
                          names:
                            type: object
                            properties:
                              count:
                                type: integer
                                xml:
                                  attribute: true
                              name:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    seq_no:
                                      type: integer
                                      example: 1
                                      xml:
                                        attribute: true
                                    role:
                                      example: author
                                      type: string
                                      xml:
                                        attribute: true
                                    claim_status:
                                      type: boolean
                                      xml:
                                        attribute: true
                                    full_name:
                                      type: string
                                      example: Lauridsen, S. V.
                                    addr_no:
                                      type: string
                                      example: 1
                                      xml:
                                        attribute: true
                                    reprint:
                                      type: string
                                      example: Y
                                      xml:
                                        attribute: true
                                    last_name:
                                      type: string
                                      example: Lauridsen
                                    display_name:
                                      type: string
                                      example: Lauridsen, S. V.
                                    wos_standard:
                                      type: string
                                      example: Lauridsen, SV
                                    r_id:
                                      type: string
                                      xml:
                                        attribute: true
                                    daisng_id:
                                      type: integer
                                      xml:
                                        attribute: true
                                    orcid_id:
                                      type: string
                                      xml:
                                        attribute: true
                                    noncore_startyear:
                                      type: integer
       

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