创建配体文件预览任务
功能介绍
创建配体文件预览任务,支持SMI、SDF、PDB、MOL2。
URI
POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/ligand/preview
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
受体的数据源:外部网络数据(如RCSB在线数据库)、用户私有数据中心、承载租户公共数据(含样例/公共库)。 枚举值:
|
|
url |
否 |
String |
文件URL,当数据源为外部网络数据时为https地址;用户私有数据中心为项目路径、公共数据场景为obs地址。 最小长度:1 最大长度:2000 |
|
format |
否 |
String |
文件格式,支持PDB、SDF、MOL2、SMI,仅数据源为RAW时提供。 最小长度:1 最大长度:6 |
|
data |
否 |
String |
文件原始数据,仅数据源为RAW时提供。 最小长度:0 最大长度:10000000 |
响应参数
状态码: 201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
任务ID。 最小长度:1 最大长度:128 |
请求示例
{
"ligand_file" : {
"source" : "RAW",
"format" : "PDB",
"data" : "MODEL1 XXX..."
},
"generate_3d" : false
}
响应示例
状态码: 201
配体预览任务创建成功响应。
{
"id" : "c05ebc2029c24699af2354f67391604c"
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
配体预览任务创建成功响应。 |
错误码
请参见错误码。