What is the endpoint for [B011] Medical Literature Search?

The [B011] Medical Literature Search endpoint is POST https://connect.patsnap.com/synapse/paper/search.

What data can [B011] Medical Literature Search return?

[B011] Medical Literature Search Obtain Literature through fields such as target, organization, disease, etc. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [B011] Medical Literature Search?

The OpenAPI schema is available at /openapi.json#/paths/~1synapse~1paper~1search/post. You can also browse the full specification at /openapi.json.

[B011] Medical Literature Search

post

https://connect.patsnap.com/synapse/paper/search

Try in Sandbox

Obtain Literature through fields such as target, organization, disease, etc.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`offset`	`integer<int64>`	-	Offset, default 0
`limit`	`integer<int64>`	`10`	Limit, default 10. offset + limit <= 10000， limit up to 1,000.
`keyword`	`object`	`{ "value": [ "PD-1" ], "condition": "OR" }`	Keywords, The "condition" field defaults to OR and AND.
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`value`	`array`	`[ "keytruda" ]`	Value List
`drug`	`object`	`{ "value": [ "2838b95ade834c96b17ac8bcd2b68c27" ], "condition": "OR" }`	Intervention Drug, The "condition" field defaults to OR and AND.
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`value`	`array`	`[ "945fa31ebe9e41ae912e493aa3324576" ]`	Value List
`target`	`object`	`{ "value": [ "d9461748c4c54a0b84cbad2ae3fce7d5" ], "condition": "OR" }`	Target, The "condition" field defaults to OR and AND.
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`value`	`array`	`[ "9786d32e3d244a688ec6a60d2fe1b10b" ]`	Value List
`disease`	`object`	`{ "value": [ "f319fa27684c4cdeb6ce59d897217718" ], "condition": "OR" }`	Indication, The "condition" field defaults to OR and AND.
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`value`	`array`	`[ "62eaee6d9ee44410b8aca59dfc7408e9" ]`	Value List
`organization`	`object`	`{ "value": [ "55317f856f0d78124a6845222345ba8e" ], "condition": "OR" }`	Institution, The "condition" field defaults to OR and does not support AND.
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`value`	`array`	`[ "6a8c172f1efc649035845f94c31a9c1e" ]`	Value List
`drug_type`	`object`	`{ "value": [ "1151dbc710f64a85923dc05d4a5a0ba9" ], "condition": "OR" }`	Drug Type, The "condition" field defaults to OR and does not support AND.
`condition`	`string`	`OR`	Logical operators, The value is an enum with the following values:AND,OR. Case-sensitive.
`value`	`array`	`[ "c38eb408d6b842f487d6a27484156633" ]`	Value List
`author`	`array`	`[ "Hutchins, Beth" ]`	Author
`publication_year`	`object`	`{ "to": 2021, "from": 2019 }`	出版年, Referencing "PaperSearchPublicationYearLongRangeItem"
`from`	`integer<int64>`	`2019`	from
`to`	`integer<int64>`	`2021`	to
`sort`	`array`	`[ { "sort_field": "score", "sort_order": "desc" } ]`	Sorting fields. The value is an enum with the following values: score, PUBLICATION_DATE. The default sorting is by Relevancy descending order. Referencing "PaperSearchSortDto"
`sort_field`	`string`	`score`	sort field, enum values: score, PUBLICATION_DATE
`sort_order`	`string`	`desc`	sort order, support:desc,asc

Request Example

Example request body for this API endpoint

JSON

{
  "drug": {
    "value": [
      "945fa31ebe9e41ae912e493aa3324576"
    ],
    "condition": "OR"
  },
  "sort": [
    {
      "sort_field": "score",
      "sort_order": "desc"
    }
  ],
  "limit": 10,
  "author": [
    "Hutchins, Beth"
  ],
  "offset": 0,
  "target": {
    "value": [
      "9786d32e3d244a688ec6a60d2fe1b10b"
    ],
    "condition": "OR"
  },
  "disease": {
    "value": [
      "62eaee6d9ee44410b8aca59dfc7408e9"
    ],
    "condition": "OR"
  },
  "keyword": {
    "value": [
      "keytruda"
    ],
    "condition": "OR"
  },
  "drug_type": {
    "value": [
      "c38eb408d6b842f487d6a27484156633"
    ],
    "condition": "OR"
  },
  "organization": {
    "value": [
      "6a8c172f1efc649035845f94c31a9c1e"
    ],
    "condition": "OR"
  },
  "publication_year": {
    "to": 2021,
    "from": 2019
  }
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`items`	`array`	`Please check the form:PaperDetailDto`	result items
`paper_id`	`string`	`0b20bcfa-6399-30bf-ab29-6a0fafbbe3bd`	Paper ID
`paper_title`	`array`	`[ { "lang": "EN", "title": "Adding PD-1/PD-L1 Inhibitors to Chemotherapy for the First-Line Treatment of Extensive Stage Small Cell Lung Cancer (SCLC): A Meta-Analysis of Randomized Trials" } ]`	Paper Title
`lang`	`string`	`EN`	Paper Title Language
`title`	`string`	`Adding PD-1/PD-L1 Inhibitors to Chemotherapy for the First-Line Treatment of Extensive Stage Small Cell Lung Cancer (SCLC): A Meta-Analysis of Randomized Trials`	Paper Title
`limit`	`integer<int64>`	`10`	limit
`total`	`integer<int64>`	`10`	total
`offset`	`integer<int64>`	-	offset
`status` Required	`boolean`	`false`	Status
`error_msg`	`string`	`The request parameter format is incorrect！`	Error Message
`error_code` Required	`integer`	`0`	Error Code

Success Response Example

Example of a successful API response

JSON

{
  "data": {
    "items": [
      {
        "paper_id": "0b20bcfa-6399-30bf-ab29-6a0fafbbe3bd",
        "paper_title": [
          {
            "lang": "EN",
            "title": "Adding PD-1/PD-L1 Inhibitors to Chemotherapy for the First-Line Treatment of Extensive Stage Small Cell Lung Cancer (SCLC): A Meta-Analysis of Randomized Trials"
          }
        ]
      }
    ],
    "limit": 10,
    "total": 10,
    "offset": 0
  },
  "status": true,
  "error_code": 0
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error Code	Description
`68300004`	Invalid parameter!
`68300005`	Search api failure!
`68300006`	Analytic basic access error!
`68300007`	Bad request!
`68300008`	Service error, please try again later!
`68300010`	The file does not comply with upload specifications!

Platform Errors

Error Code	Description
`67200000`	API call exceeds the total limit set by the platform!
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	The current call rate is too fast, exceeding the current configuration limit QPS!
`67200003`	The key and secret parameters for applying for the token are incorrect or the client has been disabled!
`67200004`	The requested api does not have permission. Please contact our support personnel!
`67200005`	Insufficient account balance/number of calls!
`67200006`	The client has exceeded the activation validity period!
`67200007`	The current call exceeds the configured usage limit of the day!
`67200008`	Please check if the required apikey in the query parameter has been transmitted!
`67200009`	The apikey does not match the passed bearerToken. Please check if a valid token is being used!
`67200012`	The request is illegal!
`67200100`	The current server status is busy, request response timeout!
`67200101`	The API requested currently does not exist. Please check the request path!

HTTP Status Codes

Status Code	Description
`0`	Success
`201`	Created
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

Performance Metrics

Expected performance characteristics for this endpoint

Normal Response Time

5000 ms

Max Response Time

10000 ms