工作流

方法与权限

API	GET	POST	PUT	PATCH	DELETE
工作流列表	管理员, 成员	管理员	-	-	-
工作流详情	管理员, 成员	-	-	管理员	管理员

获取工作流列表

端点: /tables/workflow/list/{level}/{sid}/{serializer}/

该端点允许您获取工作流列表。

参数: level (路径, 字符串)

组织

参数: sid (路径, 字符串)

组织 sid

参数: serializer (路径, 字符串)

名称, 列表, 详情

参数: token (头部, 字符串)

认证令牌

参数: table__sid (查询, 布尔值)

工作流是表特定的，提供 table__sid 以查询特定于表的工作流

响应: 200 — 成功获取数据。

# serializer = name
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 1,
    "count": 3,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "name": "Plan an experiment"
        },
        ...
    ]
}
# serializer = list
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 1,
    "count": 3,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "name": "Plan an experiment",
            "parent": null,
            "number_of_steps": 5,
            "is_archived": false,
            "table": {
                "sid": "xxx",
                "name": "experiments"
            },
            "change_permission": true
        },
        ...
    ]
}
# serializer = detail
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 1,
    "count": 3,
    "next": null,
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "table": {
                "sid": "xxx",
                "name": "experiments"
            },
            "parent": null,
            "name": "Plan an experiment",
            "description": "This workflow describes what you need to do before start an experiment.",
            "number_of_steps": 5,
            "is_archived": false,
            "updated_by": "xxx",
            "date_updated": "2020-02-10T03:02:27.172051Z",
            "date_created": "2020-02-10T03:02:27.171200Z",
            "change_permission": true
        },
        ...
    ]
}

创建工作流列表

端点: /tables/workflow/list/{level}/{sid}/{serializer}/

该端点允许您创建工作流列表。

参数: level (路径, 字符串)

组织

参数: sid (路径, 字符串)

组织 sid

参数: serializer (路径, 字符串)

详情

参数: token (头部, 字符串)

认证令牌

参数: table__sid (查询, 字符串)

参数: parent (正文, 数字)

参数: name (正文, 字符串)

参数: description (正文, 字符串)

响应: 201

{
    "sid": "xxx",
    "table": {
        "sid": "xxx",
        "name": "experiments"
    },
    "parent": null,
    "name": "Plan an experiment",
    "description": "This workflow describes what you need to do before start an experiment.",
    "number_of_steps": 5,
    "is_archived": false,
    "updated_by": "xxx",
    "date_updated": "2020-02-10T03:02:27.172051Z",
    "date_created": "2020-02-10T03:02:27.171200Z",
    "change_permission": true
}

响应: 406

Missing table__sid in get parameters

获取工作流详情

端点: /tables/workflow/detail/{sid}/

参数: sid (路径, 字符串)

参数: token (头部, 字符串)

响应: 200

{
    "sid": "xxx",
    "table": {
        "name": "xxx",
        "sid": "xxx"
    },
    "parent": null,
    "name": "xxx",
    "description": "xxx",
    "number_of_steps": 4,
    "is_archived": false,
    "updated_by": "xxx",
    "date_updated": "2019-07-03T06:15:01.667876Z",
    "date_created": "2019-06-29T07:31:31.706125Z",
    "change_permission": true
}

更新工作流详情

端点: /tables/workflow/detail/{sid}/

操作级别: 管理员

参数: sid (路径, 字符串)

参数: token (头部, 字符串)

参数: parent (正文, 数字)

参数: name (正文, 字符串)

参数: description (正文, 字符串)

参数: is_archived (正文, 布尔值)

参数: trigger__sid (查询, 字符串)

在查询中传递 trigger__sid 作为行 sid 以触发工作流并更新变量

参数: event (查询, 字符串)

在查询中传递 event 以更新执行日志，与 trigger__sid 一起使用

参数: workflow_data (正文, 对象)

用于更新执行的附加数据，与 trigger__sid 一起使用

参数: variables (正文, 对象)

用于解析工作流数据的附加变量，与 trigger__sid 一起使用

响应: 200

{
    "sid": "xxx",
    "table": {
        "name": "xxx",
        "sid": "xxx"
    },
    "parent": null,
    "name": "xxx",
    "description": "xxx",
    "number_of_steps": 4,
    "is_archived": false,
    "updated_by": "xxx",
    "date_updated": "2019-07-03T06:15:01.667876Z",
    "date_created": "2019-06-29T07:31:31.706125Z",
    "change_permission": true
}

删除工作流详情

端点: /tables/workflow/detail/{sid}/

参数: sid (路径, 字符串)

参数: token (头部, 字符串)

响应: 204

{}