You need to enable JavaScript to run this app.
导航
UpdateWorkflow - 更新工作流
最近更新时间:2024.04.23 14:21:05首次发布时间:2023.02.10 20:00:02

更新工作流

请求参数

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

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

UpdateWorkflow

要执行的操作,取值:UpdateWorkflow。

Version
String

2021-03-04

API的版本,取值:2021-03-04。

ID
String

fcxxxxxxxxxxxxxxxxxxx

工作流ID

Name
String

name

工作流名称

Description
String

description

工作流描述

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编码

返回参数

本接口无特有的返回参数。更多信息请见返回结构

请求示例

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

返回示例

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

错误码

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

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

参数错误

403
ForbiddenErr
<透传错误内容>

无权限

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

资源不存在

500
InternalErr
<透传错误内容>

内部错误