[B023] 临床相关实体
通过临床试验id或者登记号获取临床相关实体
clinical_trial_id 和 register_number 两个参数必须传一个
请求参数
此 API 接口支持的参数列表
| 名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| string | 202425a889e52ae802432a8295220e53 | 临床试验id，通过临床试验检索接口获取 |
| string | NCT06498986 | 登记号 |
响应结构
API 响应数据的结构说明
| 字段名 | 类型 | 示例 | 描述 |
|---|---|---|---|
data | object | - | 响应数据 |
target | array | [
{
"target_id": "928facc8122849baa0dc00759cff0380",
"short_name": [
{
"lang": "EN",
"name": "KRAS G12C"
}
],
"display_name": [
{
"lang": "EN",
"name": "GTPase KRas G12C"
},
{
"lang": "CN",
"name": "KRAS G12C突变"
}
]
}
] | 靶点 |
target_id | string | 1c2067e5ab054a8995f73efcfcf56207 | 靶点ID |
short_name | array | [
{
"lang": "EN",
"name": "VEGF"
}
] | 靶点简称，引用“CommonName” |
lang | string | EN | 语言 |
name | string | Ranibizumab (Genentech) | 药物、靶点、机构、适应症、国家/地区、字典、作用机制 名称 |
display_name | array | [
{
"lang": "EN",
"name": "Vascular endothelial growth factor"
},
{
"lang": "CN",
"name": "血管内皮生长因子"
}
] | 靶点全称，引用“CommonName” |
condition | array | [
"Non-small Cell Lung Cancer"
] | 适应症原始值 |
control_drug | array | [
{
"drug_id": "79c4211933534056b4a84db1766df362",
"display_name": [
{
"lang": "EN",
"name": "Osimertinib mesylate"
},
{
"lang": "CN",
"name": "甲磺酸奥希替尼"
}
]
}
] | 对照药物 |
drug_id | string | e82b83b42eba4e5ea3f26f8e06081a5a | 药物ID |
display_name | array | [
{
"lang": "EN",
"name": "Ranibizumab (Genentech)"
},
{
"lang": "CN",
"name": "雷珠单抗"
}
] | 药物名称，引用“CommonName” |
organization | array | [
{
"display_name": [
{
"lang": "EN",
"name": "Sichuan Baili Pharmaceuticals Co.,Ltd"
},
{
"lang": "CN",
"name": "四川百利药业有限责任公司"
}
],
"organization_id": "685e5cad5351555103932a4c484281c2"
}
] | 申办/合作机构 |
display_name | array | [
{
"lang": "EN",
"name": "Roche Holding AG"
},
{
"lang": "CN",
"name": "罗氏"
}
] | 机构名称，引用“CommonName” |
organization_id | string | 87bfaf037f8e60c9e25595cd98bb27e4 | 机构ID |
register_number | string | NCT06498986 | 登记号 |
clinical_trial_id | string | 202425a889e52ae802432a8295220e53 | 临床试验ID |
condition_disease | array | [
{
"disease_id": "6c9886cb25eb45faba70292cee1f5518",
"display_name": [
{
"lang": "EN",
"name": "Locally Advanced Lung Non-Small Cell Carcinoma"
},
{
"lang": "CN",
"name": "局部晚期非小细胞肺癌"
}
]
}
] | 适应症 |
disease_id | string | 06a9082fe1ec4c97bea31d888b9cfdce | 适应症ID |
display_name | array | [
{
"lang": "EN",
"name": "Uveitic Macular Edema"
},
{
"lang": "CN",
"name": "葡萄膜炎黄斑水肿"
}
] | 适应症名称，引用“CommonName” |
main_experimentation_drug | array | [
{
"drug_id": "79c4211933534056b4a84db1766df362",
"display_name": [
{
"lang": "EN",
"name": "Osimertinib mesylate"
},
{
"lang": "CN",
"name": "甲磺酸奥希替尼"
}
]
}
] | 试验药物 |
status必填 | boolean | false | 状态 |
error_msg | string | The request parameter format is incorrect！ | 错误信息 |
error_code必填 | integer | 0 | 错误代码 |
成功响应示例
成功调用 API 的响应示例
JSON
{
"data": {
"target": [
{
"target_id": "1c2067e5ab054a8995f73efcfcf56207",
"short_name": [
{
"lang": "EN",
"name": "Ranibizumab (Genentech)"
}
],
"display_name": [
{
"lang": "EN",
"name": "Ranibizumab (Genentech)"
}
]
}
],
"condition": [
"Non-small Cell Lung Cancer"
],
"control_drug": [
{
"drug_id": "e82b83b42eba4e5ea3f26f8e06081a5a",
"display_name": [
{
"lang": "EN",
"name": "Ranibizumab (Genentech)"
}
]
}
],
"organization": [
{
"display_name": [
{
"lang": "EN",
"name": "Ranibizumab (Genentech)"
}
],
"organization_id": "87bfaf037f8e60c9e25595cd98bb27e4"
}
],
"register_number": "NCT06498986",
"clinical_trial_id": "202425a889e52ae802432a8295220e53",
"condition_disease": [
{
"disease_id": "06a9082fe1ec4c97bea31d888b9cfdce",
"display_name": [
{
"lang": "EN",
"name": "Ranibizumab (Genentech)"
}
]
}
],
"main_experimentation_drug": [
{
"drug_id": "e82b83b42eba4e5ea3f26f8e06081a5a",
"display_name": [
{
"lang": "EN",
"name": "Ranibizumab (Genentech)"
}
]
}
]
},
"status": true,
"error_code": 0
}错误码
此接口可能返回的错误码列表
业务错误码
| 错误码 | 描述 |
|---|---|
68300004 | 请求参数异常! |
68300005 | 查询Api失败! |
68300006 | 解析基本存取错误! |
68300007 | 存在错误的请求! |
68300008 | 服务中断异常，请稍后再试! |
68300010 | 文件不符合上传规范! |
平台错误码
| 错误码 | 描述 |
|---|---|
67200001 | API整体限流错误! |
67200002 | 用户调用请求限流限制错误! |
67200003 | 申请token的key和secret不正确或者状态错误! |
67200004 | 无权限或该接口的套餐已超过系统设置的上限! |
67200005 | 账户余额不足，调用失败! |
67200006 | 客户端已过期，调用失败! |
67200007 | 超过调用额度，调用失败! |
HTTP 状态码
| 状态码 | 描述 |
|---|---|
0 | 请求成功 |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
性能指标
此接口的预期性能特征
正常响应时间
5000 ms
最大响应时间
10000 ms