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

ListWorkflows - 获取工作流列表

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

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

我的收藏

获取工作流列表

请求参数

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

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

ListWorkflows

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

Version
String
是

2021-03-04

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

PageNumber
Integer
否

1

分页页码

PageSize
Integer
否

10

分页页长

Filter
ListWorkflowsFilter
否

null

筛选条件

SortBy
String
否

Name

按字段排序，包括Name,CreateTime,UpdateTime,ID

SortOrder
String
否

Desc

指定排序顺序

WorkspaceID
String
是

wcxxxxxxxxxxxxxxxxxxx

工作空间ID

返回参数

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

参数
类型
示例值
描述
PageSize
Integer

10

分页页长

TotalCount
Integer

100

总条数

PageNumber
Integer

1

分页页码

Items
Array of WorkflowItem

[]

工作流列表

请求示例

POST /?Action=ListWorkflows&Version=2021-03-04
Content-Type:application/json
{
    "WorkspaceID": "wcxxxxxxxxxxxxxxxxxxx",
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "Keyword": "test-workflow",
        "IDs": ["fcxxxxxxxxxxxxxxxxxxx"]
    },
    "SortBy": "CreateTime",
    "SortOrder": "Desc"
}

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "ListWorkflows",
        "Version": "2021-03-04",
        "Service": "bio",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "ID": "fcxxxxxxxxxxxxxxxxxxx",
                "Name": "name",
                "Description": "description",
                "CreateTime": 1673525239,
                "UpdateTime": 1673525239,
                "Language": "WDL",
                "Source": "https://aaa.bbb.git",
                "Tag": "master",
                "Token": "xxxxxxxx",
                "MainWorkflowPath": "main.wdl",
                "Status": {
                    "Phase": "Succeeded",
                    "Message": "xxxxxxxx"
                },
                "Inputs": [
                    {
                        "Name": "xxxxxxxx",
                        "Type": "xxxxxxxx",
                        "Optional": false,
                        "Default": "xxxxxxxx"
                    }
                ],
                "Outputs": [
                    {
                        "Name": "xxxxxxxx",
                        "Type": "xxxxxxxx",
                        "Optional": false,
                        "Default": "xxxxxxxx"
                    }
                ],
                "OwnerName": "name",
                "Graph": "xxxxxxxx",
                "SourceType": "git"
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 100
    }
}

错误码

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

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

参数错误

403
ForbiddenErr
<透传错误内容>

无权限

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

资源不存在

500
InternalErr
<透传错误内容>

内部错误