You need to enable JavaScript to run this app.
导航
生信操作系统Bio-OS
  • 文档首页
    • /
  • 生信操作系统Bio-OS

CreateWorkflow - 创建工作流

最近更新时间：2024.04.23 14:21:05

首次发布时间：2023.02.10 20:00:02

我的收藏

创建工作流

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

CreateWorkflow

要执行的操作，取值：CreateWorkflow。

Version
String
是

2021-03-04

API的版本，取值：2021-03-04。

Name
String
是

name

工作流名称

Description
String
否

description

工作流描述

Language
String
是

WDL

语言类型，例如WDL

Source
String
否

https://github.com/a/b.git

来源，http(s)开头的地址。为file/dev来源类型时不填

Tag
String
否

v1.0.0

来源版本。git类型对应tag/branch，dockstore类型对应version，file/dev类型时不填

Token
String
否

xxxx

私有git拉取token，dockstore/file/dev类型时不填

MainWorkflowPath
String
否

path/main.wdl

主工作流文件路径，dockstore来源时不填

WorkspaceID
String
是

wcxxxxxxxxxxxxxxxxxxx

工作空间ID

SourceType
String
是

git

来源类型，包括git,dockstore,file,dev

Content
String
否

d2RsLnppcA==

文件导入的二进制zip包base64编码

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
ID
String

fcxxxxxxxxxxxxxxxxxxx

工作流ID

请求示例

POST /?Action=CreateWorkflow&Version=2021-03-04
Content-Type:application/json
{
    "WorkspaceID": "wcxxxxxxxxxxxxxxxxxxx",
    "Name": "name",
    "Description": "description",
    "Language": "WDL",
    "Source": "https://aaa.com/ccc.git",
    "Tag": "v1.0.0",
    "Token": "xxxxxxxx",
    "MainWorkflowPath": "path/main.wdl",
    "SourceType": "git"
}

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "CreateWorkflow",
        "Version": "2021-03-04",
        "Service": "bio",
        "Region": "cn-beijing"
    },
    "Result": {
        "ID": "wcxxxxxxxxxxxxxxxxxxx"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
ParamErr
<透传错误内容>

参数错误

403
ForbiddenErr
<透传错误内容>

无权限

404
NotFoundErr
<资源类型>[<具体资源id>] not found

资源不存在

409
AlreadyExistErr
<资源类型>[<具体资源名称>] already exist

资源已存在

500
InternalErr
<透传错误内容>

内部错误