SearchInput

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/clarivate/main/json-schema/clarivate-search-input-schema.json",
  "title": "SearchInput",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/clarivate-web-of-science-reviewer-locator-api-api-openapi.yml#/components/schemas/SearchInput",
  "type": "object",
  "required": [
    "searchArticle"
  ],
  "properties": {
    "requestId": {
      "description": "Optional consumer-defined request identifier. If provided in the request, will be returned in the response.",
      "type": "string"
    },
    "searchArticle": {
      "$ref": "#/$defs/SearchArticle"
    },
    "excludedReviewers": {
      "type": "array",
      "description": "List of additional individuals to exclude from the recommendations. Note that it is not necessary to re-list 'authors' here as they will already be excluded from the recommendations. Unlike 'authors', 'excludedReviewers' will not be used for conflict of interest checks.",
      "items": {
        "$ref": "#/$defs/ExcludedReviewer"
      }
    },
    "searchYears": {
      "type": "integer",
      "description": "Base reviewer recommendations on Web of Science publications published within the last 3, 4, or 5 years.",
      "default": 3,
      "minimum": 3,
      "maximum": 5
    },
    "numRecommendations": {
      "type": "integer",
      "description": "Number of recommendations to fetch. Note that the API will not always return the full number of recommendations requested.",
      "default": 30,
      "minimum": 15,
      "maximum": 100
    },
    "includedCountries": {
      "type": "array",
      "description": "If provided, reviewer recommendations will be restricted to researchers recently affiliated with organizations from the listed countries. 'includedCountries' and 'excludedCountries' should not be used in conjunction.",
      "items": {
        "$ref": "#/$defs/Country"
      }
    },
    "excludedCountries": {
      "type": "array",
      "description": "If provided, reviewer recommendations will be restricted to researchers without recent affiliations with organizations from the listed countries. 'includedCountries' and 'excludedCountries' should not be used in conjunction.",
      "items": {
        "$ref": "#/$defs/Country"
      }
    }
  },
  "$defs": {
    "AuthorOrApplicant": {
      "type": "object",
      "required": [
        "firstName",
        "lastName"
      ],
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "email": {
          "type": "string",
          "format": "email"
        },
        "organizations": {
          "type": "array",
          "description": "Affiliated organizations. Used to check for potential conflicts of interest by co-affiliation.",
          "items": {
            "$ref": "#/$defs/AuthorOrganization"
          }
        }
      }
    },
    "AuthorOrganization": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string"
        }
      }
    },
    "Country": {
      "type": "object",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string"
        }
      }
    },
    "ExcludedReviewer": {
      "type": "object",
      "required": [
        "firstName",
        "lastName"
      ],
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "email": {
          "type": "string",
          "format": "email"
        }
      }
    },
    "JournalOrFunder": {
      "type": "object",
      "description": "Journal or funding agency.",
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string"
        }
      }
    },
    "SearchArticle": {
      "type": "object",
      "description": "Input manuscript or grant application details.",
      "required": [
        "title",
        "abstract",
        "journal"
      ],
      "properties": {
        "title": {
          "type": "string"
        },
        "abstract": {
          "type": "string"
        },
        "journal": {
          "$ref": "#/$defs/JournalOrFunder"
        },
        "authors": {
          "type": "array",
          "description": "List of manuscript authors or grant application applicants. Will be excluded from the recommendations. Will also be used to check for potential conflicts of interest by co-publication or co-affiliation.",
          "items": {
            "$ref": "#/$defs/AuthorOrApplicant"
          }
        }
      }
    }
  }
}