更新时间:2024-05-09 GMT+08:00
分享

创建分子或分子复合物批量下载任务

功能介绍

创建分子或分子复合物批量下载任务。

URI

POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/drug-common/toolkit/batch-download

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,您可以从获取项目ID中获取。

最小长度:1

最大长度:128

eihealth_project_id

String

平台项目ID。

最小长度:1

最大长度:128

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

最小长度:1

最大长度:32768

表3 请求Body参数

参数

是否必选

参数类型

描述

job_id

String

作业ID。

最小长度:1

最大长度:128

job_result_url

String

作业结果文件url。

最小长度:1

最大长度:2000

mode

String

下载类型:MOL(小分子)、COMPLEX(复合物)。

最小长度:3

最大长度:7

selected

Array of integers

选中下载的分子下标。

最小值:0

最大值:1000000

数组长度:1 - 10000

响应参数

状态码: 201

表4 响应Body参数

参数

参数类型

描述

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

创建分子或分子复合物批量下载任务成功。

错误码

请参见错误码

相关文档