{
  "service": "web_of_science",
  "displayName": "Web of Science",
  "description": "Search Web of Science documents and journals through the Clarivate Web of Science Starter API.",
  "categories": [
    "Data"
  ],
  "authTypes": [
    "api_key"
  ],
  "auth": [
    {
      "type": "api_key",
      "label": "API Key",
      "placeholder": "WEB_OF_SCIENCE_API_KEY",
      "description": "Web of Science API key sent in the X-ApiKey header. Register an application and subscribe to the Starter API in the Clarivate Developer Portal: https://developer.clarivate.com/apis/wos-starter"
    }
  ],
  "homepageUrl": "https://clarivate.com/academia-government/scientific-and-academic-research/research-discovery-and-referencing/web-of-science/",
  "actions": [
    {
      "id": "web_of_science.get_document",
      "service": "web_of_science",
      "name": "get_document",
      "description": "Get one Web of Science document by its accession number (UID).",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "uid": {
            "type": "string",
            "minLength": 1,
            "description": "The Web of Science accession number, such as WOS:000267144200002.",
            "pattern": "\\S"
          },
          "detail": {
            "type": "string",
            "enum": [
              "full",
              "short"
            ],
            "description": "The record detail level. Full records are returned when this field is omitted or set to full."
          }
        },
        "additionalProperties": false,
        "required": [
          "uid"
        ],
        "description": "The input payload for retrieving one Web of Science document."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "document": {
            "type": "object",
            "properties": {
              "uid": {
                "type": "string",
                "description": "The Web of Science unique identifier."
              },
              "title": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The document title when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "types": {
                "type": "array",
                "items": {
                  "type": "string",
                  "description": "One normalized document type."
                },
                "description": "The normalized document types."
              },
              "sourceTypes": {
                "type": "array",
                "items": {
                  "type": "string",
                  "description": "One source document type."
                },
                "description": "The source document types."
              },
              "source": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": true,
                    "description": "The Web of Science source metadata when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "names": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": true,
                    "description": "The contributor and author metadata when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "links": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": true,
                    "description": "The Web of Science product links when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "citations": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": true,
                  "description": "One times-cited entry."
                },
                "description": "The times-cited entries returned by Web of Science."
              },
              "identifiers": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": true,
                    "description": "The DOI, ISSN, ISBN, PubMed, and related identifiers when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "keywords": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": true,
                    "description": "The document keyword metadata when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "raw": {
                "type": "object",
                "additionalProperties": true,
                "description": "The raw document object returned by Web of Science."
              }
            },
            "additionalProperties": false,
            "required": [
              "uid",
              "title",
              "types",
              "sourceTypes",
              "source",
              "names",
              "links",
              "citations",
              "identifiers",
              "keywords",
              "raw"
            ],
            "description": "A normalized Web of Science document record."
          }
        },
        "additionalProperties": false,
        "required": [
          "document"
        ],
        "description": "The response returned when retrieving one Web of Science document."
      }
    },
    {
      "id": "web_of_science.get_journal",
      "service": "web_of_science",
      "name": "get_journal",
      "description": "Get one Web of Science journal by its journal identifier.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "description": "The Web of Science journal identifier returned by search_journals.",
            "pattern": "\\S"
          }
        },
        "additionalProperties": false,
        "required": [
          "id"
        ],
        "description": "The input payload for retrieving one Web of Science journal."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "journal": {
            "type": "object",
            "properties": {
              "id": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The Web of Science journal identifier when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "name": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The journal's full name when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "jcrTitle": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The Journal Citation Reports abbreviation when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "isoTitle": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The ISO journal title when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "issn": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The journal ISSN when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "eIssn": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "The journal electronic ISSN when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "previousIssn": {
                "type": "array",
                "items": {
                  "type": "string",
                  "description": "One previous ISSN."
                },
                "description": "The previous ISSNs associated with the journal."
              },
              "links": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": true,
                  "description": "One journal product link."
                },
                "description": "The Web of Science product links for the journal."
              },
              "raw": {
                "type": "object",
                "additionalProperties": true,
                "description": "The raw journal object returned by Web of Science."
              }
            },
            "additionalProperties": false,
            "required": [
              "id",
              "name",
              "jcrTitle",
              "isoTitle",
              "issn",
              "eIssn",
              "previousIssn",
              "links",
              "raw"
            ],
            "description": "A normalized Web of Science journal record."
          }
        },
        "additionalProperties": false,
        "required": [
          "journal"
        ],
        "description": "The response returned when retrieving one Web of Science journal."
      }
    },
    {
      "id": "web_of_science.search_documents",
      "service": "web_of_science",
      "name": "search_documents",
      "description": "Search Web of Science documents with Starter API advanced queries, filters, sorting, and pagination.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "query": {
            "type": "string",
            "minLength": 1,
            "description": "The Web of Science advanced query, such as TS=(machine learning) or DO=10.1000/example.",
            "pattern": "\\S"
          },
          "database": {
            "type": "string",
            "enum": [
              "BCI",
              "BIOABS",
              "BIOSIS",
              "CCC",
              "DIIDW",
              "DRCI",
              "MEDLINE",
              "PPRN",
              "RC",
              "WOK",
              "WOS",
              "ZOOREC"
            ],
            "description": "The Web of Science database abbreviation to search. Defaults to WOS."
          },
          "limit": {
            "type": "integer",
            "minimum": 1,
            "maximum": 50,
            "description": "The maximum number of records to return on this page."
          },
          "page": {
            "type": "integer",
            "minimum": 1,
            "description": "The one-based page number to retrieve."
          },
          "sortField": {
            "type": "string",
            "minLength": 1,
            "description": "The sort expression, such as PY+D for publication year descending or TC+D for times cited descending.",
            "pattern": "\\S"
          },
          "modifiedTimeSpan": {
            "type": "string",
            "minLength": 1,
            "description": "The record modification date range in YYYY-MM-DD+YYYY-MM-DD form.",
            "pattern": "\\S"
          },
          "publishTimeSpan": {
            "type": "string",
            "minLength": 1,
            "description": "The publication date range in YYYY-MM-DD+YYYY-MM-DD form.",
            "pattern": "\\S"
          },
          "timesCitedModifiedTimeSpan": {
            "type": "string",
            "minLength": 1,
            "description": "The times-cited modification date range in YYYY-MM-DD+YYYY-MM-DD form.",
            "pattern": "\\S"
          },
          "detail": {
            "type": "string",
            "enum": [
              "full",
              "short"
            ],
            "description": "The record detail level. Full records are returned when this field is omitted or set to full."
          },
          "edition": {
            "type": "string",
            "minLength": 1,
            "description": "The collection and edition expression, such as WOS+SCI, with multiple editions separated by commas.",
            "pattern": "\\S"
          }
        },
        "additionalProperties": false,
        "required": [
          "query"
        ],
        "description": "The input payload for searching Web of Science documents.",
        "allOf": [
          {
            "not": {
              "required": [
                "modifiedTimeSpan",
                "publishTimeSpan"
              ]
            }
          },
          {
            "if": {
              "properties": {
                "database": {
                  "const": "WOK"
                }
              },
              "required": [
                "database"
              ]
            },
            "then": {
              "not": {
                "anyOf": [
                  {
                    "required": [
                      "modifiedTimeSpan"
                    ]
                  },
                  {
                    "required": [
                      "timesCitedModifiedTimeSpan"
                    ]
                  }
                ]
              }
            }
          }
        ]
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "metadata": {
            "type": "object",
            "properties": {
              "total": {
                "anyOf": [
                  {
                    "type": "integer",
                    "description": "The total number of matching records when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "page": {
                "anyOf": [
                  {
                    "type": "integer",
                    "description": "The one-based page number when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "limit": {
                "anyOf": [
                  {
                    "type": "integer",
                    "description": "The maximum number of records on the page when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "additionalProperties": false,
            "required": [
              "total",
              "page",
              "limit"
            ],
            "description": "Pagination metadata returned by Web of Science."
          },
          "documents": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "uid": {
                  "type": "string",
                  "description": "The Web of Science unique identifier."
                },
                "title": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "The document title when available."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "types": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "description": "One normalized document type."
                  },
                  "description": "The normalized document types."
                },
                "sourceTypes": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "description": "One source document type."
                  },
                  "description": "The source document types."
                },
                "source": {
                  "anyOf": [
                    {
                      "type": "object",
                      "additionalProperties": true,
                      "description": "The Web of Science source metadata when available."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "names": {
                  "anyOf": [
                    {
                      "type": "object",
                      "additionalProperties": true,
                      "description": "The contributor and author metadata when available."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "links": {
                  "anyOf": [
                    {
                      "type": "object",
                      "additionalProperties": true,
                      "description": "The Web of Science product links when available."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "citations": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "additionalProperties": true,
                    "description": "One times-cited entry."
                  },
                  "description": "The times-cited entries returned by Web of Science."
                },
                "identifiers": {
                  "anyOf": [
                    {
                      "type": "object",
                      "additionalProperties": true,
                      "description": "The DOI, ISSN, ISBN, PubMed, and related identifiers when available."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "keywords": {
                  "anyOf": [
                    {
                      "type": "object",
                      "additionalProperties": true,
                      "description": "The document keyword metadata when available."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "raw": {
                  "type": "object",
                  "additionalProperties": true,
                  "description": "The raw document object returned by Web of Science."
                }
              },
              "additionalProperties": false,
              "required": [
                "uid",
                "title",
                "types",
                "sourceTypes",
                "source",
                "names",
                "links",
                "citations",
                "identifiers",
                "keywords",
                "raw"
              ],
              "description": "A normalized Web of Science document record."
            },
            "description": "The matching Web of Science documents."
          },
          "raw": {
            "type": "object",
            "additionalProperties": true,
            "description": "The raw Web of Science list response."
          }
        },
        "additionalProperties": false,
        "required": [
          "metadata",
          "documents",
          "raw"
        ],
        "description": "The response returned when searching Web of Science documents."
      }
    },
    {
      "id": "web_of_science.search_journals",
      "service": "web_of_science",
      "name": "search_journals",
      "description": "Search Web of Science journals, optionally by ISSN.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "issn": {
            "type": "string",
            "minLength": 1,
            "description": "The print, electronic, or previous ISSN to search for.",
            "pattern": "\\S"
          }
        },
        "additionalProperties": false,
        "description": "The input payload for searching Web of Science journals."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "metadata": {
            "type": "object",
            "properties": {
              "total": {
                "anyOf": [
                  {
                    "type": "integer",
                    "description": "The total number of matching records when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "page": {
                "anyOf": [
                  {
                    "type": "integer",
                    "description": "The one-based page number when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "limit": {
                "anyOf": [
                  {
                    "type": "integer",
                    "description": "The maximum number of records on the page when available."
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "additionalProperties": false,
            "required": [
              "total",
              "page",
              "limit"
            ],
            "description": "Pagination metadata returned by Web of Science."
          },
          "journals": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "The Web of Science journal identifier when available."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "name": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "The journal's full name when available."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "jcrTitle": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "The Journal Citation Reports abbreviation when available."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "isoTitle": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "The ISO journal title when available."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "issn": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "The journal ISSN when available."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "eIssn": {
                  "anyOf": [
                    {
                      "type": "string",
                      "description": "The journal electronic ISSN when available."
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "previousIssn": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "description": "One previous ISSN."
                  },
                  "description": "The previous ISSNs associated with the journal."
                },
                "links": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "additionalProperties": true,
                    "description": "One journal product link."
                  },
                  "description": "The Web of Science product links for the journal."
                },
                "raw": {
                  "type": "object",
                  "additionalProperties": true,
                  "description": "The raw journal object returned by Web of Science."
                }
              },
              "additionalProperties": false,
              "required": [
                "id",
                "name",
                "jcrTitle",
                "isoTitle",
                "issn",
                "eIssn",
                "previousIssn",
                "links",
                "raw"
              ],
              "description": "A normalized Web of Science journal record."
            },
            "description": "The matching Web of Science journals."
          },
          "raw": {
            "type": "object",
            "additionalProperties": true,
            "description": "The raw Web of Science journal list response."
          }
        },
        "additionalProperties": false,
        "required": [
          "metadata",
          "journals",
          "raw"
        ],
        "description": "The response returned when searching Web of Science journals."
      }
    }
  ]
}