生成相互作用2D图
功能介绍
生成相互作用2D图,如果不提供配体文件,则受体文件中必须包含配体;如果提供配体文件,则受体中的配体(如果有)则会被忽略。
URI
POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/interaction2d
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
eihealth_project_id |
是 |
String |
参数解释: 空间ID。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
receptor_file |
是 |
ReceptorDrugFileReq object |
参数解释: 受体文件。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
ligand_file |
否 |
DrugFile object |
参数解释: 配体文件。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
name |
否 |
String |
参数解释: 小分子名称。 约束限制: 不涉及 取值范围: 长度为[0-128]个字符。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
source |
是 |
String |
参数解释: 受体数据源。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
url |
否 |
String |
参数解释: 文件URL。 约束限制: 当数据源source为外部网络数据时为https地址,为用户私有数据中心时为空间路径,为公共数据场景时为obs地址。 取值范围: 文件URL需以pdb结尾,长度为[1-2000]个字符。 默认取值: 不涉及 |
format |
否 |
String |
参数解释: 文件格式。 约束限制: 当数据源source为RAW时提供。 取值范围: 仅支持PDB。 默认取值: 不涉及 |
data |
否 |
String |
参数解释: 文件原始数据。 约束限制: 当数据源source为RAW时提供。 取值范围: 长度为[0-10000000]个字符。 默认取值: 不涉及 |
add_hydrogen |
否 |
Boolean |
参数解释: 是否增加氢原子。 约束限制: 不涉及 取值范围:
默认取值: true |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
source |
是 |
String |
参数解释: 受体数据源。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
url |
否 |
String |
参数解释: 文件URL。 约束限制: 当数据源source为外部网络数据时为https地址,为用户私有数据中心时为空间路径,为公共数据场景时为obs地址 取值范围: 文件仅URL仅支持以.pdb、.mol2、.sdf、.smi为结尾,长度为[1-2000]个字符。 默认取值: 不涉及 |
format |
否 |
String |
参数解释: 文件格式。 约束限制: 当数据源source为RAW时提供。 取值范围:
默认取值: 不涉及 |
data |
否 |
String |
参数解释: 文件原始数据。 约束限制: 当数据源source为RAW时提供。 取值范围: 长度为[0-10000000]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
相互作用2D图生成成功响应。
无
请求示例
生成相互作用2D图,受体文件为test.pdb,配体为源数据。
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/interaction2d { "receptor_file" : { "source" : "PRIVATE", "url" : "project:/test.pdb" }, "ligand_file" : { "source" : "RAW", "format" : "SDF", "data" : "xxxxxxx" } }
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
相互作用2D图生成成功响应。 |
错误码
请参见错误码。