更新工作流
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
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 | <透传错误内容> | 内部错误 |