SearchRequest

Search request body for POST endpoint

ResearchAcademicBibliometricsCitationsScienceScholarly

Properties

Name Type Description
databaseId string Database to search
usrQuery string Advanced search query using WOS query syntax
count integer Number of records to return
firstRecord integer Starting record number
editions array Database editions to search
publishTimeSpan object
sortField string Sort field and direction
View JSON Schema on GitHub

JSON Schema

web-of-science-search-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/web-of-science-apis/json-schema/web-of-science-search-request-schema.json",
  "title": "SearchRequest",
  "description": "Search request body for POST endpoint",
  "type": "object",
  "properties": {
    "databaseId": {
      "type": "string",
      "description": "Database to search",
      "default": "WOS"
    },
    "usrQuery": {
      "type": "string",
      "description": "Advanced search query using WOS query syntax"
    },
    "count": {
      "type": "integer",
      "description": "Number of records to return",
      "default": 10
    },
    "firstRecord": {
      "type": "integer",
      "description": "Starting record number",
      "default": 1
    },
    "editions": {
      "type": "array",
      "description": "Database editions to search",
      "items": {
        "type": "string"
      }
    },
    "publishTimeSpan": {
      "$ref": "#/components/schemas/TimeSpan"
    },
    "sortField": {
      "type": "string",
      "description": "Sort field and direction"
    }
  }
}