创建study作业
功能介绍
创建study作业
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/studies/{study_id}/jobs
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
eihealth_project_id | 是 | String | 平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。 最小长度:1 最大长度:128 |
project_id | 是 | String | 华为云项目ID,您可以从获取项目ID中获取。 最小长度:1 最大长度:128 |
study_id | 是 | String | study_id 最小长度:1 最大长度:128 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
workflow_job_id | 是 | String | workflow作业id 最小长度:1 最大长度:128 |
template_id | 否 | String | 数据库模板id 最小长度:1 最大长度:128 |
database_name | 是 | String | 数据库名称 最小长度:3 最大长度:32 |
relative_path | 是 | String | 生成数据库实例的文件相对路径 最小长度:0 最大长度:1024 |
output_file_type | 是 | String | 生成数据库实例的文件类型。枚举值:csv、txt、vcf 枚举值:
|
响应参数
状态码: 201
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | study作业id |
请求示例
创建药筛作业,指定已创建的流程作业id、数据库模板id、数据库名称、生成结果的相对路径、输出文件类型
https://eihealth.cn-north-4.myhuaweicloud.com/v1/{project_id}/eihealth-projects/{eihealth_project_id}/studies/{study_id}/jobs
{
"workflow_job_id" : "fce1376b-72f9-4d15-9f95-9b533cb96fda",
"template_id" : "e1ae25a0-070b-41ca-a1a9-3cb8db39e169",
"database_name" : "demo-database",
"relative_path" : "docking-summary",
"output_file_type" : "csv"
} 响应示例
状态码: 201
CREATED
{
"id" : "e1ae25a0-070b-41ca-a1a9-3cb8db39e169"
} 状态码
状态码 | 描述 |
|---|---|
201 | CREATED |
错误码
请参见错误码。

