[B012] 临床试验检索的接口地址是什么？

[B012] 临床试验检索的接口为 POST https://connect.zhihuiya.com/synapse/clinical-trial/search。

[B012] 临床试验检索可以返回哪些数据？

[B012] 临床试验检索：通过靶点、机构、适应症等字段，获取相关临床试验。完整响应结构请参见本页的响应结构与成功响应示例。

在哪里可以找到 [B012] 临床试验检索的 OpenAPI schema？

OpenAPI schema 位于 /openapi.json#/paths/~1synapse~1clinical-trial~1search/post，也可在 /openapi.json 浏览完整规范。

[B012] 临床试验检索

Q: [B012] 临床试验检索 的接口地址是什么？

[B012] 临床试验检索 的接口为 POST https://connect.zhihuiya.com/synapse/clinical-trial/search。

post

https://connect.zhihuiya.com/synapse/clinical-trial/search

在体验中心中试用

通过靶点、机构、适应症等字段，获取相关临床试验

请求参数

此 API 接口支持的参数列表

名称	类型	示例	描述
`offset`	`integer<int64>`	-	偏移量，默认0
`limit`	`integer<int64>`	`10`	返回条数，默认10。 offset + limit <= 20000， limit最大设置1000
`keyword`	`object`	`{ "value": [ "CRISPR" ], "condition": "OR" }`	关键词，condition默认为OR，支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "keytruda" ]`	值列表
`main_experimentation_drug`	`object`	`{ "value": [ "2838b95ade834c96b17ac8bcd2b68c27" ], "condition": "OR" }`	试验药，condition默认为OR，支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "945fa31ebe9e41ae912e493aa3324576" ]`	值列表
`control_drug`	`object`	`{ "value": [ "01b23c90dfeb41ddae473c4f576668ad" ], "condition": "OR" }`	对照药，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "945fa31ebe9e41ae912e493aa3324576" ]`	值列表
`organization`	`object`	`{ "value": [ "55317f856f0d78124a6845222345ba8e" ], "condition": "OR" }`	申办/合作机构，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "6a8c172f1efc649035845f94c31a9c1e" ]`	值列表
`target`	`object`	`{ "value": [ "d9461748c4c54a0b84cbad2ae3fce7d5" ], "condition": "OR" }`	靶点，condition默认为OR，支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "9786d32e3d244a688ec6a60d2fe1b10b" ]`	值列表
`mechanism_action`	`object`	`{ "value": [ "138f7edea9d70a30233e854b342a1eca" ], "condition": "OR" }`	作用机制，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "4dd338b149b3ecd0ee860e1fb379b44f" ]`	值列表
`disease`	`object`	`{ "value": [ "f319fa27684c4cdeb6ce59d897217718" ], "condition": "OR" }`	适应症，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "62eaee6d9ee44410b8aca59dfc7408e9" ]`	值列表
`drug_type`	`object`	`{ "value": [ "1151dbc710f64a85923dc05d4a5a0ba9" ], "condition": "OR" }`	药物类型，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "c38eb408d6b842f487d6a27484156633" ]`	值列表
`study_identifier`	`object`	`{ "value": [ "DESTINY-Breast04" ], "condition": "OR" }`	试验代号，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "MK-3475-587" ]`	值列表
`register_number`	`object`	`{ "value": [ "NCT05047601" ], "condition": "OR" }`	登记号，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "NCT03486873" ]`	值列表
`title`	`object`	`{ "value": [ "COVID-19" ], "condition": "OR" }`	临床试验标题，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "Tumors" ]`	值列表
`recruitment_status`	`array`	`[ "Recruiting" ]`	招募状态，枚举值：Not_Yet_Recruiting、Recruiting、Enrolling_By_Invitation、Active_Not_Recruiting、Suspended、Terminated、Completed、Withdrawn、Unknown_Status
`phase`	`array`	`[ "Phase_3" ]`	试验分期，枚举值：Early_Phase_1、Phase_1、Phase_1_2、Phase_2、Phase_2_3、Phase_3、Phase_4、Not_Applicable
`start_date`	`object`	`{ "to": 1546387199999, "from": 1514764800000 }`	开始日期，引用"ClinicalTrialSearchStartDateLongRangeItem"
`from`	`integer<int64>`	`1514764800000`	范围起始
`to`	`integer<int64>`	`1546387199999`	范围截止
`first_posted_date`	`object`	`{ "to": 1546387199999, "from": 1514764800000 }`	首次公示日期，引用"ClinicalTrialSearchFirstPostedDateLongRangeItem"
`from`	`integer<int64>`	`1514764800000`	范围起始
`to`	`integer<int64>`	`1546387199999`	范围截止
`enrollment`	`array`	`[ "GREATER_THAN_FIVE_HUNDRED" ]`	招募人数，枚举值：LESS_THAN_FIFTEEN、FIFTEEN_TO_SIXTY、SIXTY_TO_THREE_HUNDRED、THREE_HUNDRED_TO_FIVE_HUNDRED、GREATER_THAN_FIVE_HUNDRED
`organization_type`	`array`	`[ "Company" ]`	机构类型，枚举值：Company、University_Institution、Other
`employee_number`	`array`	`[ "GREATER_THAN_500" ]`	雇员数量，枚举值：LESS_THAN_10、BETWEEN_10_AND_100、BETWEEN_100_AND_500、GREATER_THAN_500
`country`	`array`	`[ "Asia" ]`	国家/地区，枚举值：Asia、North_America、Europe、Oceania、South_America、US、EU、CN、JP、Other
`therapeutic_area`	`array`	`[ "62eaee6d9ee44410b8aca59dfc7408e9" ]`	治疗领域，通过 [B058]-治疗领域ID查询接口获得
`sort`	`array`	`[ { "sort_field": "STUDY_FIRST_POSTED_DATE", "sort_order": "desc" }, { "sort_field": "START_DATE", "sort_order": "desc" }, { "sort_field": "LAST_UPDATE_POSTED_DATE", "sort_order": "desc" } ]`	排序字段，枚举值：STUDY_FIRST_POSTED_DATE、START_DATE、LAST_UPDATE_POSTED_DATE。默认首次公式日期倒序，开始日期倒序、更新日期倒序。引用"ClinicalTrialSearchSortDto"
`sort_field`	`string`	`STUDY_FIRST_POSTED_DATE`	排序字段，枚举值：STUDY_FIRST_POSTED_DATE、START_DATE、LAST_UPDATE_POSTED_DATE
`sort_order`	`string`	`desc`	排序方式，支持：desc,asc

请求示例

该 API 接口的请求体示例

JSON

{
  "sort": [
    {
      "sort_field": "STUDY_FIRST_POSTED_DATE",
      "sort_order": "desc"
    }
  ],
  "limit": 10,
  "phase": [
    "Phase_3"
  ],
  "title": {
    "value": [
      "Tumors"
    ],
    "condition": "OR"
  },
  "offset": 0,
  "target": {
    "value": [
      "9786d32e3d244a688ec6a60d2fe1b10b"
    ],
    "condition": "OR"
  },
  "country": [
    "Asia"
  ],
  "disease": {
    "value": [
      "62eaee6d9ee44410b8aca59dfc7408e9"
    ],
    "condition": "OR"
  },
  "keyword": {
    "value": [
      "keytruda"
    ],
    "condition": "OR"
  },
  "drug_type": {
    "value": [
      "c38eb408d6b842f487d6a27484156633"
    ],
    "condition": "OR"
  },
  "enrollment": [
    "GREATER_THAN_FIVE_HUNDRED"
  ],
  "start_date": {
    "to": 1546387199999,
    "from": 1514764800000
  },
  "control_drug": {
    "value": [
      "945fa31ebe9e41ae912e493aa3324576"
    ],
    "condition": "OR"
  },
  "organization": {
    "value": [
      "6a8c172f1efc649035845f94c31a9c1e"
    ],
    "condition": "OR"
  },
  "employee_number": [
    "GREATER_THAN_500"
  ],
  "register_number": {
    "value": [
      "NCT03486873"
    ],
    "condition": "OR"
  },
  "mechanism_action": {
    "value": [
      "4dd338b149b3ecd0ee860e1fb379b44f"
    ],
    "condition": "OR"
  },
  "study_identifier": {
    "value": [
      "MK-3475-587"
    ],
    "condition": "OR"
  },
  "therapeutic_area": [
    "62eaee6d9ee44410b8aca59dfc7408e9"
  ],
  "first_posted_date": {
    "to": 1546387199999,
    "from": 1514764800000
  },
  "organization_type": [
    "Company"
  ],
  "recruitment_status": [
    "Recruiting"
  ],
  "main_experimentation_drug": {
    "value": [
      "945fa31ebe9e41ae912e493aa3324576"
    ],
    "condition": "OR"
  }
}

响应结构

API 响应数据的结构说明

字段名	类型	示例	描述
`data`	`object`	-	响应数据
`items`	`array`	`Please check the form:ClinicalTrialSearchDetail`	查询结果
`brief_title`	`string`	`Finding an Effective Dose of GM1 to Reduce or Prevent Neuropathy (Numbness or Weakness) Due to Treatment With Paclitaxel (Phase II)`	Brief Title
`official_title`	`string`	`An Early Phase and Phase II Clinical Trial to Evaluate Ganglioside-Monosialic Acid (GM1) for Preventing Paclitaxel-Associated Neuropathy`	Official Title
`register_number`	`string`	`NCT05751668`	登记号
`clinical_trial_id`	`string`	`e3a8282e8e85590e2ad225a2522ea828`	临床试验ID
`limit`	`integer<int64>`	`10`	返回条数
`total`	`integer<int64>`	`10`	总量
`offset`	`integer<int64>`	-	偏移量
`status` 必填	`boolean`	`false`	状态
`error_msg`	`string`	`The request parameter format is incorrect！`	错误信息
`error_code` 必填	`integer`	`0`	错误代码

成功响应示例

成功调用 API 的响应示例

JSON

{
  "data": {
    "items": [
      {
        "brief_title": "Finding an Effective Dose of GM1 to Reduce or Prevent Neuropathy (Numbness or Weakness) Due to Treatment With Paclitaxel (Phase II)",
        "official_title": "An Early Phase and Phase II Clinical Trial to Evaluate Ganglioside-Monosialic Acid (GM1) for Preventing Paclitaxel-Associated Neuropathy",
        "register_number": "NCT05751668",
        "clinical_trial_id": "e3a8282e8e85590e2ad225a2522ea828"
      }
    ],
    "limit": 10,
    "total": 10,
    "offset": 0
  },
  "status": true,
  "error_code": 0
}

错误码

此接口可能返回的错误码列表

业务错误码

错误码	描述
`68300004`	请求参数异常!
`68300005`	查询Api失败!
`68300006`	解析基本存取错误!
`68300007`	存在错误的请求!
`68300008`	服务中断异常，请稍后再试!
`68300010`	文件不符合上传规范!

平台错误码

错误码	描述
`67200000`	API整体限流错误!
`67200001`	API整体限流错误！
`67200002`	当前调用速率过快,超过当前配置限制QPS！
`67200003`	申请token的key和secret传参不正确或者客户端已被禁用！
`67200004`	请求的接口无权限请联系我们的支持人员！
`67200005`	账户余额/调用次数不足！
`67200006`	客户端超过开通有效期！
`67200007`	当前调用超过当天配置使用额度！
`67200008`	请检查query参数中必填的apikey是否传输！
`67200009`	apikey与所传的bearerToken不匹配,请检查是否使用在有效期内的token！
`67200012`	请求不合法！
`67200100`	当前服务器状态正忙,请求响应超时！
`67200101`	当前请求的Api不存在请检查请求Path！

HTTP 状态码

状态码	描述
`0`	请求成功
`201`	Created
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

性能指标

此接口的预期性能特征

正常响应时间

5000 ms

最大响应时间

10000 ms