[B044] 临床结果检索的接口地址是什么？

[B044] 临床结果检索的接口为 POST https://connect.zhihuiya.com/synapse/ct-result/search。

[B044] 临床结果检索可以返回哪些数据？

[B044] 临床结果检索：通过药物、靶点、适应症等获取临床结果。完整响应结构请参见本页的响应结构与成功响应示例。

在哪里可以找到 [B044] 临床结果检索的 OpenAPI schema？

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

[B044] 临床结果检索

Q: [B044] 临床结果检索 是什么？

通过药物、靶点、适应症等获取临床结果

Q: [B044] 临床结果检索 的接口地址是什么？

[B044] 临床结果检索 的接口为 POST https://connect.zhihuiya.com/synapse/ct-result/search。

post

https://connect.zhihuiya.com/synapse/ct-result/search

在体验中心中试用

通过药物、靶点、适应症等获取临床结果

请求参数

此 API 接口支持的参数列表

名称	类型	示例	描述
`offset`	`integer<int64>`	-	偏移量，默认0
`limit`	`integer<int64>`	`10`	返回条数，默认10。 offset + limit <= 10000， limit最大设置1000
`main_experimentation_drug`	`object`	`{ "value": [ "945fa31ebe9e41ae912e493aa3324576" ], "condition": "OR" }`	主要试验药，condition默认为OR, 支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "945fa31ebe9e41ae912e493aa3324576" ]`	值列表
`overall_enrollment`	`object`	`{ "to": 1000, "from": 500 }`	评价人数
`from`	`integer<int64>`	`500`	范围起始
`to`	`integer<int64>`	`1000`	范围截止
`sort`	`array`	`[ { "sort_field": "ANNOTATION_METHOD_RANK", "sort_order": "desc" } ]`	字段排序，field支持：ANNOTATION_METHOD_RANK；order支持desc, asc（默认desc）
`sort_field`	`string`	`PUBLISHED_TIME`	排序字段，枚举值：PUBLISHED_TIME
`sort_order`	`string`	`desc`	排序方式，支持：desc,asc
`disease`	`object`	`{ "value": [ "62eaee6d9ee44410b8aca59dfc7408e9" ], "condition": "OR" }`	适应症，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "62eaee6d9ee44410b8aca59dfc7408e9" ]`	值列表
`target`	`object`	`{ "value": [ "9786d32e3d244a688ec6a60d2fe1b10b" ], "condition": "OR" }`	靶点，condition默认为OR，支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "9786d32e3d244a688ec6a60d2fe1b10b" ]`	值列表
`sponsor_collaborator_organization`	`object`	`{ "value": [ "6a8c172f1efc649035845f94c31a9c1e" ], "condition": "OR" }`	申办/合作机构ID，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "6a8c172f1efc649035845f94c31a9c1e" ]`	值列表
`study_code`	`array`	`[ "KEYNOTE-045" ]`	试验代号
`register_number`	`array`	`[ "NCT02256436" ]`	登记号
`drug_type`	`object`	`{ "value": [ "c38eb408d6b842f487d6a27484156633" ], "condition": "OR" }`	药物类型，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "c38eb408d6b842f487d6a27484156633" ]`	值列表
`control_drug`	`object`	`{ "value": [ "095fdb04424f4214a7b26b7ff6877e67" ], "condition": "OR" }`	对照药，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "095fdb04424f4214a7b26b7ff6877e67" ]`	值列表
`therapeutic_area`	`array`	`[ "62eaee6d9ee44410b8aca59dfc7408e9" ]`	治疗领域，通过 [B058]-治疗领域ID查询接口获得
`mechanism_action`	`object`	`{ "value": [ "4dd338b149b3ecd0ee860e1fb379b44f" ], "condition": "OR" }`	作用机制，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "4dd338b149b3ecd0ee860e1fb379b44f" ]`	值列表
`ct_result_meeting`	`array`	`[ "c47a5730bf5e40b3aa76c26820ec6d4e" ]`	临床结果大会ID，通过字典查询接口获取
`outcome`	`object`	`{ "value": [ "84a502e8ba664184bd01fbee1e8554c3" ], "condition": "OR" }`	指标，condition默认为OR，不支持AND。
`condition`	`string`	`OR`	逻辑运算符，枚举值：AND、OR，大小写敏感。
`value`	`array`	`[ "84a502e8ba664184bd01fbee1e8554c3" ]`	值列表
`therapy_type`	`array`	`[ "SECOND_LINE" ]`	疗法类型。枚举值：FIRST_LINE、SECOND_LINE、THIRD_LINE、LAST_LINE、ADJUVANT、NEOADJUVANT、MAINTENANCE、CONSOLIDATION、ADD_ON、INDUCTION。
`phase`	`array`	`[ "Phase_3" ]`	试验分期。枚举值：Early_Phase_1、Phase_1、Phase_1_2、Phase_2、Phase_2_3、Phase_3、Phase_4、Not_Applicable。
`publish_time`	`object`	`{ "to": 1514851199999, "from": 1483228800000 }`	发表日期
`from`	`integer<int64>`	`1483228800000`	范围起始
`to`	`integer<int64>`	`1514851199999`	范围截止
`general_evaluation`	`array`	`[ "POSITIVE" ]`	评价。枚举值：SUPERIORITY、POSITIVE、NON_INFERIORITY、SIMILAR、NON_SUPERIORITY、NEGATIVE

请求示例

该 API 接口的请求体示例

JSON

{
  "sort": [
    {
      "sort_field": "PUBLISHED_TIME",
      "sort_order": "desc"
    }
  ],
  "limit": 10,
  "phase": [
    "Phase_3"
  ],
  "offset": 0,
  "target": {
    "value": [
      "9786d32e3d244a688ec6a60d2fe1b10b"
    ],
    "condition": "OR"
  },
  "disease": {
    "value": [
      "62eaee6d9ee44410b8aca59dfc7408e9"
    ],
    "condition": "OR"
  },
  "outcome": {
    "value": [
      "84a502e8ba664184bd01fbee1e8554c3"
    ],
    "condition": "OR"
  },
  "drug_type": {
    "value": [
      "c38eb408d6b842f487d6a27484156633"
    ],
    "condition": "OR"
  },
  "study_code": [
    "KEYNOTE-045"
  ],
  "control_drug": {
    "value": [
      "095fdb04424f4214a7b26b7ff6877e67"
    ],
    "condition": "OR"
  },
  "publish_time": {
    "to": 1514851199999,
    "from": 1483228800000
  },
  "therapy_type": [
    "SECOND_LINE"
  ],
  "register_number": [
    "NCT02256436"
  ],
  "mechanism_action": {
    "value": [
      "4dd338b149b3ecd0ee860e1fb379b44f"
    ],
    "condition": "OR"
  },
  "therapeutic_area": [
    "62eaee6d9ee44410b8aca59dfc7408e9"
  ],
  "ct_result_meeting": [
    "c47a5730bf5e40b3aa76c26820ec6d4e"
  ],
  "general_evaluation": [
    "POSITIVE"
  ],
  "overall_enrollment": {
    "to": 1000,
    "from": 500
  },
  "main_experimentation_drug": {
    "value": [
      "945fa31ebe9e41ae912e493aa3324576"
    ],
    "condition": "OR"
  },
  "sponsor_collaborator_organization": {
    "value": [
      "6a8c172f1efc649035845f94c31a9c1e"
    ],
    "condition": "OR"
  }
}

响应结构

API 响应数据的结构说明

字段名	类型	示例	描述
`data`	`object`	-	响应数据
`items`	`array`	`Please check the form:ClinicalTrialResultSummaryDto`	查询结果
`title`	`string`	`Matching-Adjusted Indirect Treatment Comparisons (MAIC) of Sotorasib 960mg (soto960) Plus Panitumumab (pani) Vs. Trifluridine/Tipiracil(T/T) Plus Bevacizumab (bev) in Chemorefractory Metastatic Colorectal Cancer (mCRC)`	标题
`data_source`	`array`	`Please check the form: ClinicalTrialResultSourceInfoDto`	数据来源
`source`	`string`	`MDS`	来源
`source_url`	`string`	`https://www.mdsabstracts.org/abstract/opicapone-improves-global-non-motor-symptoms-burden-in-parkinsons-disease-an-open-label-prospective-study`	来源url
`ct_result_id`	`string`	`2eadada4ed582332940e522e5258e52e`	临床结果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": [
      {
        "title": "Matching-Adjusted Indirect Treatment Comparisons (MAIC) of Sotorasib 960mg (soto960) Plus Panitumumab (pani) Vs. Trifluridine/Tipiracil(T/T) Plus Bevacizumab (bev) in Chemorefractory Metastatic Colorectal Cancer (mCRC)",
        "data_source": [
          {
            "source": "MDS",
            "source_url": "https://www.mdsabstracts.org/abstract/opicapone-improves-global-non-motor-symptoms-burden-in-parkinsons-disease-an-open-label-prospective-study"
          }
        ],
        "ct_result_id": "2eadada4ed582332940e522e5258e52e"
      }
    ],
    "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