创建配体文件预览任务 - CreateDrugLigandPreviewTask
功能介绍
创建配体文件预览任务,支持SMI、SDF、PDB、MOL2。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/preview
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
ligand_file | 是 | DrugFile object | 参数解释: 配体文件。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
preview_count | 否 | Integer | 参数解释: 预览数量,如果分子数量大于预览数量,则超出预览数量部分只做计数。 约束限制: 不涉及 取值范围: 0-1000 默认取值: 100 |
count_limit | 否 | Integer | 参数解释: 计数上限,如果分子数量大于计数上限,则终止计数并在结果中标明计数不完整(has_more=true),计数数量应不小于preview_count。 约束限制: 不涉及 取值范围: 0-1000000 默认取值: 1000 |
generate_3d | 否 | Boolean | 参数解释: 是否生成3D构象,默认为true。 约束限制: 不涉及 取值范围:
默认取值: 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]个字符。 默认取值: 不涉及 |
响应参数
状态码:201
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 参数解释: 任务ID。 约束限制: 不涉及 取值范围: 长度为[1-128]个字符。 默认取值: 不涉及 |
请求示例
创建配体文件预览任务,配体为源数据,且不生成3D构象。
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/preview
{
"ligand_file" : {
"source" : "RAW",
"format" : "PDB",
"data" : "MODEL1 XXX..."
},
"generate_3d" : false
} 响应示例
状态码:201
配体预览任务创建成功响应。
{
"id" : "c05ebc2029c24699af2354f67391604c"
} 状态码
状态码 | 描述 |
|---|---|
201 | 配体预览任务创建成功响应。 |
错误码
请参见错误码。

