创建批量下载任务
功能介绍
创建批量下载任务。
URI
POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/toolkit/batch-download
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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]个字符。 默认取值： 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
job_id |
是 |
String |
参数解释： 作业ID。 约束限制： 不涉及 取值范围： 长度为[1-128]个字符。 默认取值： 不涉及 |
|
job_result_url |
是 |
String |
参数解释： 作业结果文件URL。 约束限制： 不涉及 取值范围： 长度为[1-2000]个字符。 默认取值： 不涉及 |
|
mode |
是 |
String |
参数解释： 下载类型。 约束限制： 不涉及 取值范围：
默认取值： 不涉及 |
|
format |
否 |
String |
参数解释： 文件格式：pdb、sdf（仅下载小分子时支持此格式）。 约束限制： 不涉及 取值范围：
默认取值： pdb |
|
selected |
是 |
Array of integers |
参数解释： 选中下载的分子下标。 约束限制： 不涉及 取值范围： 0-10000 默认取值： 不涉及 |
响应参数
状态码：201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释： 任务ID。 约束限制： 不涉及 取值范围： 长度为[1-128]个字符。 默认取值： 不涉及 |
请求示例
创建批量下载任务。
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/toolkit/batch_download
{
"job_id" : "1296790078dbc",
"mode" : "MOL",
"selected" : [ 1, 3, 5, 7 ],
"job_result_url" : "ch-test:/job-results/docking/Molecule Docking-20230825-conformation-test-8f8a/result.json"
}
响应示例
状态码：201
创建分子或分子复合物批量下载任务成功。
{
"id" : "201213668789088"
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
创建分子或分子复合物批量下载任务成功。 |
错误码
请参见错误码。
