腾讯云微搭低代码
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>腾讯云微搭低代码>API 专区>服务端 API>工作流

工作流

最近更新时间：2024-11-08 11:34:32

我的收藏

本页目录：

基本概念

设计态

流程：腾讯云控制台编排的流程；ProcessKey 为流程的唯一标识；由于流程基于多版本设计，每个版本对应一个编码 FlowCode，在流程每次保存、发布后，会生成新的 FlowCode（ProcessKey 不变）；请参见 查询已部署的流程列表。

运行态

流程实例：触发流程后产生的运行态实例；InstanceId 为流程实例的唯一标识；一个流程可以被触发多次，即一个流程在运行态包含多个流程实例。 审批任务：每个审批节点下每个审批人被分配的任务；FlowTaskId（TaskId）为审批任务的唯一标识；在一个流程实例中，流转到某一个审批节点时，会为该审批节点下每个审批人分配审批任务，即一个流程实例包含多个审批任务。

开放接口

说明：
接口地址中变量说明：
envId（环境 ID）可前往 资源管理 页面获取。
region：目前固定为 ap-shanghai。
envType：weda 环境类型。
pre：预览环境（对应流程未发布）。
prod：正式环境（对应流程已发布）。

1. 获取用户信息（数据模型的 OpenAPI）

请求方式：GET 
请求地址：
  https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/odata/v1/{envType}/sys_user

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

返回参数示例

{
    "@odata.context":"$metadata#sys_user",
    "value":[
        {
            "_id":"1491618225351524354",
            "createdAt":1646924769165,
            "updatedAt":1656644264179,
            "createBy":"administrator",
            "updateBy":"administrator",
            "name":"administrator",
            "type":0,
            "internal_user_type":1,
            "uin":"100010452549",
            "sub_uin":"100021970282",
            "uuid":"BTk_AAEDPMs",
            "open_id":null,
            "user_desc":"超级管理员用户\\n\\n1234qwer#",
            "nick_name":null,
            "env_id":"lowcode-6ggpw0rpf76676d9",
            "project_id":null,
            "corp_id":null,
            "source":1,
            "wechat_user_id":null,
            "email":"",
            "phone":""
        }
    ]
}

_id 即为用户的唯一标识，对应来源标识 type=4。
type 取值：3.企业微信，4.weda 内部用户。
以下为流程 OpenAPI。
返回参数基本格式为：
{
    "Response":{
        "RequestId":"5ce05e64b8b79",
        "Error":{
            "Code":"",
            "Message":""
        },
        "Data":{

        }
    }
}
流程 OpenAPI 中某些接口支持返回用户详细信息，包括主列字段、角色、主岗部门、兼岗部门等，使用方式可参考接口入参 NeedUserExtraInfo，出参用户详细信息参数如下：

UserExtraInfo

字段
类型
描述
Id
string
用户唯一 id，对应 sys_user 表 _id
Name
string
用户名称
NickName
string
用户昵称
Phone
string
手机号
Email
string
电子邮箱
UserDesc
string
用户描述
Uuid
string
用户 Uuid
OpenId
string
用户 OpenId
WechatUserId
string
用户微信 id
IsLicensed
bool
是否授权 license
MainOrg
SimplifyOrg
主岗部门
SubOrgs
list<SimplifyOrg>
兼岗部门
Roles
list<SimplifyRole>
角色列表
PrimaryColumn
string
主列字段

SimplifyOrg

字段
类型
描述
OrgId
string
部门 id
OrgName
string
部门名称
Level
int
部门层级

SimplifyRole

字段
类型
描述
Id
string
角色 id
Name
string
角色名称
RoleIdentity
string
角色标识
RoleDesc
string
角色描述

2. 查询已部署的流程列表

说明：
本接口用于查询设计态已部署的流程，每次保存后出参 FlowCode 会更新，ProcessKey 不更新。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ListDeployedFlows

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
Type
int
是
流程类型。
1：逻辑流
2：审批流

返回参数

字段
类型
描述
TotalCount
int
总数
FlowSet
list<DeployedProcessInfo>
流程列表

DeployedProcessInfo

字段
类型
描述
FlowCode
string
流程编码，流程有多版本设计，每次保存、发布后 FlowCode 会更新，该接口返回最新值
ProcessKey
string
流程唯一标识
Published
bool
流程是否发布
Version
string
版本
Name
string
流程名称
Description
string
流程描述
BeginElementType
int
开始节点是否有入参。
0：没有参数
1：有参数

Body 参数示例

{
    "Type": 2
}

返回参数示例

{
    "Response": {
        "RequestId": "5ce05e64b8b79",
        "Data": {
            "FlowSet": [
                {
                    "FlowCode": "1554719964520185859",
                    "ProcessKey": "flow_dvp3ydx",
                    "Published": false,
                    "Version": "8.0",
                    "Name": "测试流程004",
                    "AppCode": "1",
                    "Description": "",
                    "BeginElementType": 0
                },
                {
                    "FlowCode": "1554428531640827906",
                    "ProcessKey": "flow_ftwl1bx",
                    "Published": false,
                    "Version": "29.0",
                    "Name": "测试流程003",
                    "AppCode": "1",
                    "Description": "",
                    "BeginElementType": 0
                },
                {
                    "FlowCode": "1554326000705142787",
                    "ProcessKey": "flow_qjtbkku",
                    "Published": false,
                    "Version": "27.0",
                    "Name": "页面测试复用",
                    "AppCode": "1",
                    "Description": "页面测试复用",
                    "BeginElementType": 0
                },
                {
                    "FlowCode": "1542085643793326083",
                    "ProcessKey": "flow_014",
                    "Published": false,
                    "Version": "1.0",
                    "Name": "页面组件触发流程",
                    "AppCode": "1",
                    "Description": "",
                    "BeginElementType": 0
                }
            ],
            "TotalCount": 4
        }
    }
}


3. 发起流程

说明：
本接口用于运行态触发流程，产生流程实例。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/StartFlow

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
FlowCode
string
否
流程编码
ProcessKey
string
是
流程唯一标识
StartParams
map<string，object>
否
流程启动入参，key 为流程开始节点变量名，value 为变量值。流程开始节点无入参时，该字段不传
StartUser
userInfo
是
流程发起人

UserInfo

字段
类型
是否必填
描述
UserId
string
是
用户 id
Type
int
是
用户来源：
1：使用用户的 uuid
2：使用用户的企微 ID
4：使用用户的 _id 或数据标识
UserExtraInfo
UserExtraInfo
否
UserInfo 作为出参且入参 NeedUserExtraInfo=true 时返回

返回参数

字段
类型
描述
FlowInstanceId
string
流程实例 ID
TaskId
string
发起人需要处理的审批任务 ID，没有则返回空

Body 参数示例

{
    "FlowCode": "1539815610601385986",
    "FlowVersion": "8.0",
    "ProcessKey": "flow_063",
    "StartParams": {
        "kt": {
            "test": "1558049980829474819"
        }
    },
    "StartUser": {
        "Type": 4,
        "UserId": "1538836331646423040"
    }
}

返回参数示例

{
    "Response":{
        "Data":{
            "FlowInstanceId":"1555098494600142849",
            "TaskId":"1555098498219827202"
        }
    }
}

4. 完成审批任务

说明：
本接口用于操作审批任务通过、驳回、转办和提交。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/CompleteTask

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
TaskId
string
是
审批任务 id
ButtonAction
int
是
审批动作：
1：提交
2：同意
3：拒绝
4：抄送
5：转办
6：加签
7：撤销
17：保存草稿
Comment
string
否
审批意见
PageParams
map<string，VariableInfo>
否
页面输出变量，当前节点配置了页面输出变量时该字段必填，key 为变量名，参考接口 GetApprovalPageDetail 出参 VariableKey
Approver
UserInfo
是
流程审批人
TurnToUser
UserInfo
否
转办人
CcUserIds
list<string>
否
抄送人 userId 列表
OpinionUserMap
map<string，string>
否
审批意见@操作人，key 为被@人的 userId，value 为被@人的用户名，以@开头
NeedUserExtraInfo
bool
否
是否返回筛选审批人详细信息

VariableInfo

字段
类型
描述
Type
string
变量类型：
对象：object
Value
object
变量值

返回参数

字段
类型
描述
ToBeSubmittedFlowTaskFlag
bool
是否弹出筛选审批人列表页面（配置了上一节点指定审批人时返回）
ToBeSubmittedFlowTaskInfo
list<ToBeSubmittedFlowTaskInfo>
待提交任务信息（同上）

ToBeSubmittedFlowTaskInfo

字段
类型
描述
Assignee
string
待审批人 id
AssigneeName
string
待审批人名称
WaitFlowTaskId
string
待提交任务 id
UserExtraInfo
UserExtraInfo
审批人详细信息

Body 参数示例

{
    "TaskId": "1539896972964917249",
    "ButtonAction": 2,
    "PageParams": {
        "approve": {
            "Type": "object",
            "Value": {
                "test": "1"
            }
        }
    },
    "Comment": "ookk",
    "Approver": {
        "Type": 4,
        "UserId": "1538836331646423040"
    },
    "CcUserIds": [
        "1558049980829474819"
    ]
}

返回参数示例

{
    "Response":{
        "RequestId":"24f7bbfbcd78d",
        "Data":{
            "OpenPageFlag":false,
            "ClosePageFlag":false,
            "RefreshPageFlag":false,
            "ToBeSubmittedFlowTaskFlag": true,
            "ToBeSubmittedFlowTaskInfo": [
                {
                    "Assignee": "1569601870691893251",
                    "AssigneeName": "test11223344",
                    "WaitFlowTaskId": "1575337230822875138"
                },
                {
                    "Assignee": "1564617649596395522",
                    "AssigneeName": "kathyzjxu",
                    "WaitFlowTaskId": "1575337230822875139"
                }
            ]
        }
    }
}

5. 终止流程

说明：
该接口用于终止流程实例，即标识为终止状态，流程实例未删除，仅支持单流程实例，多实例请参见 接口34。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/StopFlow

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
InstanceId
string
是
流程实例 id
Operator
UserInfo
是
操作人
DeleteReason
string
否
终止理由

返回参数

字段
类型
描述
Result
bool
操作结果

Body 参数示例

{
    "InstanceId": "1539815610601385986",
    "DeleteReason": "nono",
    "Operator": {
        "Type": 4,
        "UserId": "1538836331646423040"
    }
}

返回参数示例

{
    "Response":{
        "RequestId":"24f7bbf34d78d",
        "Data":{
            "Result": true
        }
    }
}

6. 查询流程实例相关信息

说明：
该接口用于直接查询流程实例列表，可用于自定义场景展示。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/GetFlowInstances

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
FlowCode
string
否
流程编码
InstanceId
string
否
流程实例 id
ProcessKey
string
否
流程标识
FlowVersion
string
否
流程版本
StartUserId
string
否
发起人 id
StartTime
long
否
流程开始时间段，示例：1688918400000
EndTime
long
否
流程结束时间段，示例：1688918400000
Status
int
否
流程状态。
1：终止（调用接口：StopFlow：终止流程）
2：正常结束-审批拒绝
3：正常结束-审批通过
4：处理中（EndTime==null）
4：废弃（EndTime!=null）
PageNumber
int
否
页码，默认1
PageSize
int
否
页面大小，默认10
Sort
string
否
排序字段，可选择 id、flow_code、flow_name、instance_id、process_key、create_by_name、start_time、end_time、is_end、status、title。默认为 start_time
Order
string
否
排序规则，升序 asc，降序 desc。默认为 desc
NeedUserExtraInfo
bool
否
是否返回发起人用户详细信息
NeedStartInputParams
bool
否
是否返回触发流程时开始节点入参

返回参数

字段
类型
描述
Result
list<FlowInstanceData>
返回结果
TotalCount
int
总数

FlowInstanceData

字段
类型
描述
InstanceId
string
流程实例 id
Description
string
流程描述
FlowCode
string
流程编码
FlowName
string
流程名称
FlowVersion
string
流程版本
StartUserName
string
流程发起人名称
StartTime
date
开始时间
EndTime
date
结束时间
Status
int
流程状态。
1：终止
2：驳回
3：同意
4：处理中
UserExtraInfo
UserExtraInfo
发起人用户详细信息
InputParams
string
开始节点入参 json 字符串
ProcessKey
string
流程标识
IsCompleted
bool
流程实例是否结束
CurrentNodeId
string
最后一次操作时审批节点 id
CurrentNodeName
string
当前审批节点名称
CurrentApprover
string
当前审批人名称，以,分隔
PageTransitionUrl
string
跳转链接
UserExtraInfos
List<UserExtraInfo>
审批人用户详细信息列表

Body 参数示例

{
    "FlowCode": "1554326000705142787"
}

返回参数示例

{
    "Response": {
        "RequestId": "24f7bbfbcd78d",
        "Data": {
            "Result": [
                {
                    "InstanceId": "1554350593668153346",
                    "Description": "kong页面预发测试复用",
                    "FlowCode": "1554326000705142787",
                    "FlowName": "kong页面预发测试复用",
                    "FlowVersion": "27.0",
                    "StartUserName": "administrator",
                    "StartTime": "2022-08-02T14:17:15.000+0800",
                    "EndTime": "2022-08-02T14:18:07.013+0800",
                    "Status": 3
                },
                {
                    "InstanceId": "1554411407090827265",
                    "Description": "kong页面预发测试复用",
                    "FlowCode": "1554326000705142787",
                    "FlowName": "kong页面预发测试复用",
                    "FlowVersion": "27.0",
                    "StartUserName": "administrator",
                    "StartTime": "2022-08-02T18:18:54.000+0800",
                    "EndTime": null,
                    "Status": 4
                },
                {
                    "InstanceId": "1554430936495865858",
                    "Description": "kong页面预发测试复用",
                    "FlowCode": "1554326000705142787",
                    "FlowName": "kong页面预发测试复用",
                    "FlowVersion": "27.0",
                    "StartUserName": "administrator",
                    "StartTime": "2022-08-02T19:36:30.000+0800",
                    "EndTime": null,
                    "Status": 4
                },
                {
                    "InstanceId": "1554725610770042881",
                    "Description": "kong页面预发测试复用",
                    "FlowCode": "1554326000705142787",
                    "FlowName": "kong页面预发测试复用",
                    "FlowVersion": "27.0",
                    "StartUserName": "administrator",
                    "StartTime": "2022-08-03T15:07:27.000+0800",
                    "EndTime": null,
                    "Status": 4
                }
            ],
            "TotalCount": 4
        }
    }
}

7. 查询流程任务相关信息

说明
该接口用于直接查询流程任务列表，可用于自定义场景展示。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/GetFlowInstanceTasks

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
InstanceId
string
否
流程实例 id
TaskAssignee
userInfo
否
任务处理人
TaskIds
list<string>
否
节点任务列表
TaskType
int
否
用户任务类型。
1：审批节点
2：处理节点
ElementIds
list<string>
否
节点 id 列表
FlowCode
string
否
流程编码
TaskStatus
int
否
任务状态。
1：待办
2：已办
3：无效（任签时可视为已办）
4：草稿箱
5：配置审批开始节点时，任务待提交
6：配置上一节点确认审批人时，任务待确认
StartUser
UserInfo
否
流程发起人
IsCarbonCopyTask
bool
否
是否查询抄送任务
StartTime
long
否
启动时间，示例：1688918400000
EndTime
long
否
结束时间，示例：1689091200000
PageNumber
int
否
页码，默认1
PageSize
int
否
页面大小，默认10
NeedUserExtraInfo
bool
否
是否返回发起人、审批人用户详细信息

返回参数

字段
类型
描述
Result
list<FlowInstanceData>
返回结果
TotalCount
int
总数

FlowInstanceData

字段
类型
描述
InstanceId
string
流程实例 id
FlowCode
string
流程编码
FlowName
string
流程名称
TaskId
string
任务 id
FlowStartUser
UserInfo
流程发起人
TaskAssignee
UserInfo
流程审批人
ElementName
string
节点名称
ElementId
string
节点 id
StartTime
date
开始时间
EndTime
date
结束时间
TaskStatus
int
任务状态。
1：待办
2：已办
3：无效（可视为已办）
4：草稿箱
OperationResult
int
操作结果
PageTransitionUrl
string
页面跳转 URL

Body 参数示例

{
    "InstanceId": "1554411407090827265",
    "TaskAssignee": {
        "UserId": "1519239780903088129",
        "Type": 4
    }
}

返回参数示例

{
    "Response": {
        "RequestId": "f82c847eb776e",
        "Data": {
            "Result": [
                {
                    "InstanceId": "1554411407090827265",
                    "TaskId": "1554411407241822210",
                    "FlowName": "kong页面预发测试复用",
                    "FlowCode": "1554326000705142787",
                    "FlowStartUser": {
                        "UserId": "1519239780903088129",
                        "Source": 4,
                    },
                    "ElementName": "审批节点",
                    "ElementId": "approvalNode1658740549804",
                    "TaskAssignee": {
                        "UserId": "1519239780903088129",
                        "Source": 4
                    },
                    "StartTime": "2022-08-02T18:18:54.000+0800",
                    "EndTime": "2022-08-02T18:19:15.952+0800",
                    "TaskStatus": 2,
                    "OperationResult": 1,
                    "PageTransitionUrl": "https://lowcode-1yyyy0000000ffff-1000000001.tcloudbaseapp.com/adminportal/#/flowCenter/detail?envType=prod&flowTaskId=1554411407241822210&pageType=TODO"
                },
                {
                    "InstanceId": "1554411407090827265",
                    "TaskId": "1554411501026459650",
                    "FlowName": "kong页面预发测试复用",
                    "FlowCode": "1554326000705142787",
                    "FlowStartUser": {
                        "UserId": "1519239780903088129",
                        "Source": 4
                    },
                    "ElementName": "处理节点",
                    "ElementId": "handleNode1658740983395",
                    "TaskAssignee": {
                        "UserId": "1519239780903088129",
                        "Source": 4
                    },
                    "StartTime": "2022-08-02T18:19:16.000+0800",
                    "EndTime": null,
                    "TaskStatus": 1,
                    "OperationResult": 0,
                    "PageTransitionUrl": "https://lowcode-1yyyy0000000ffff-1000000001.tcloudbaseapp.com/adminportal/#/flowCenter/detail?envType=prod&flowTaskId=1554411501026459650&pageType=TODO"
                }
            ],
            "TotalCount": "2"
        }
    }
}

8. 查询流程操作相关信息

说明
该接口用于直接查询流程操作列表，可用于自定义场景展示，注意：不包含待操作的流程记录，如果需要请参见 接口23。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/GetFlowInstanceOperations

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
InstanceId
string
是
流程实例 id
ElementIds
list<string>
否
节点 id 列表
OperatorUser
userInfo
否
处理人
PageNumber
int
否
页码，默认1
PageSize
int
否
页面大小，默认10
NeedUserExtraInfo
bool
否
是否返回操作人用户详细信息

返回参数

字段
类型
描述
TotalCount
int
总数
Result
list<InstanceOperationData>
操作信息列表

InstanceOperationData

字段
类型
描述
ElementName
string
节点名称
CreateTime
string
创建时间
OperatorUser
string
处理人 id
Content
string
操作内容，ContentEntity 的 JSON 字符串
UserExtraInfo
UserExtraInfo
操作人用户详细信息

ContentEntity

字段
类型
描述
action
int
节点名称操作动作
1：提交
2：同意
3：拒绝
4：转办
5：撤销
6：回退
7：加签
8：已终止
9：跳过
13：处理
15：节点抄送
16：废弃流程
17：保存草稿
operation
string
操作记录
operationComment
string
审批意见
ccUserIds
list<string>
抄送人员 id 列表

operation 值为 json 字符串

动作编号
动作名称
描述
json 字符串示例
5
撤销
撤销文案
"审批人撤销"或"发起人撤销"
7
会签
会签人的 json 字符串，类型为 list<Info>
"[{\\"id\\":\\"1526534489242292225\\",\\"name\\":\\"zhihhwang\\"}]"
其它
-
-
空

Body 参数示例

{
    "InstanceId": "1554430936495865858"
}

返回参数示例

{
    "Response": {
        "RequestId": "6b0ca9c32645b",
        "Data": {
            "Result": [
                {
                    "ElementName": "审批节点",
                    "CreateTime": "2022-08-02T19:37:30.000+0800",
                    "OperatorUser": "1519239780903088129",
                    "Content": "{\\"action\\":1}",
                    "Result": "null"
                },
                {
                    "ElementName": "处理节点",
                    "CreateTime": "2022-08-02T21:15:39.000+0800",
                    "OperatorUser": "1519239780903088129",
                    "Content": "{\\"action\\":7,\\"operation\\":\\"[{\\\\\\"id\\\\\\":\\\\\\"1526534489242292225\\\\\\",\\\\\\"name\\\\\\":\\\\\\"zhihhwang\\\\\\"}]\\"}",
                    "Result": ""
                },
                {
                    "ElementName": "处理节点",
                    "CreateTime": "2022-08-03T19:27:19.000+0800",
                    "OperatorUser": "1519239780903088129",
                    "Content": "{\\"action\\":13,\\"attachmentInfo\\":\\"[]\\",\\"highlightPositionList\\":\\"{\\\\\\"0\\\\\\":8}\\",\\"operationComment\\":\\"@test444 \\",\\"opinionUserMap\\":{1554724262350057473:\\"@test444\\"}}",
                    "Result": "true"
                },
                {
                    "ElementName": "处理节点2",
                    "CreateTime": "2022-08-04T11:21:05.000+0800",
                    "OperatorUser": "1519239780903088129",
                    "Content": "{\\"action\\":13,\\"attachmentInfo\\":\\"[]\\",\\"highlightPositionList\\":\\"{}\\",\\"operationComment\\":\\"\\",\\"opinionUserMap\\":{}}",
                    "Result": "true"
                },
                {
                    "ElementName": "抄送节点",
                    "CreateTime": "2022-08-04T11:21:06.000+0800",
                    "OperatorUser": "1519239780903088129",
                    "Content": "{\\"action\\":15,\\"ccUserIds\\":[\\"1553998386666287107\\",\\"1553997249586278403\\",\\"1553992135223947266\\",\\"1552612219926151170\\",\\"1551541491038621698\\",\\"1547563442778505218\\",\\"1547563183042035714\\",\\"1547561921202454530\\",\\"1547124661749587970\\",\\"1546402094529970177\\",\\"1531462359262003201\\",\\"1527588973928275970\\",\\"1526747841874911233\\",\\"1526534489242292225\\",\\"1522849562653122561\\",\\"1519239780903088129\\"]}",
                    "Result": ""
                }
            ],
            "TotalCount": 5
        }
    }
}

9. 查询流程实例详情

说明
本接口对应企业工作台审批页面查询流程实例详情，用于渲染流程详情中的基本信息。



请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/DescribeProcessInstance

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
FlowTaskId
string
是
审批任务 id
PageType
string
是
请求类型：
TODO：待办
DONE：已办
CREATE：创建
CC：抄送
UserInfo
UserInfo
是
用户信息
NeedUserExtraInfo
bool
否
是否返回发起人、审批人用户详细信息

返回参数

字段
类型
描述
InstanceId
string
流程实例 id
Name
string
流程名称
Description
string
流程描述
StartedBy
string
创建人
StartUserId
string
创建人 id
CanRevoke
bool
是否允许撤回
CcTime
long
抄送时间，示例：1688918400000
CcId
string
抄送 id
CurrentApprove
string
当前审批人 id
CurrentApproverName
string
当前审批人名称
StartTime
long
流程开始时间，示例：1688918400000
EndTime
long
流程结束时间，示例：1689091200000
IsCompleted
bool
审批是否完成
CurrentNodeId
string
当前审批节点 id
CurrentNodeName
string
当前审批节点名称
CurrentNodeType
int
当前审批节点类型
TaskId
string
当前审批节点的任务 id
FlowCode
string
流程定义的 FlowCode
FlowVersion
string
流程定义的版本
CanApprove
bool
是否具有审批权限
CanDelete
bool
是否能够删除流程实例
Status
int
流程结束状态。
1：终止
2：驳回
3：同意
BeSubmitNode
bool
是否是提交节点
UserExtraInfos
list<UserExtraInfo>
发起人、审批人用户详细信息

Body 参数示例

{
    "FlowTaskId": "1554350812862480385",
    "PageType": "CC",
    "UserInfo": {
        "UserId": "1519239780903088129",
        "Type": 4
    }
}

返回参数示例

{
    "Response": {
        "RequestId": "kongtest-456",
        "Data": {
            "InstanceId": "1592819459751174146",
            "Name": "kongtest提交的kongprod",
            "Description": "",
            "StartedBy": "kongtest",
            "StartUserId": 1558049980829474819,
            "CanRevoke": false,
            "CcTime": null,
            "CcId": null,
            "CurrentApprover": "1558049980829474819",
            "CurrentApproverName": "kongtest",
            "StartTime": 1668592727000,
            "EndTime": 1668592916200,
            "IsCompleted": true,
            "CurrentNodeId": "handleNode1664245555540",
            "CurrentNodeName": "处理节点",
            "CurrentNodeType": 23,
            "TaskId": "1592819864610562049",
            "FlowCode": "1581977369708285954",
            "FlowVersion": "16.0",         
            "CanApprove": true,
            "CanDelete": false,
            "UserTaskType": 2,
            "Status": 3,
            "BeSubmitNode": false
        }
    }
}

10. 查询审批页面详情

说明
本接口对应企业工作台审批页面查询审批页面详情，需要先调用 查询流程实例详情 查询当前流程实例是否结束，以及当前任务对应的节点 ID、FlowCode 等信息，用于渲染表单数据、审批按钮。



请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/GetApprovalPageDetail

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
InstanceId
string
是
流程实例 id
FlowCode
string
否
流程内部编码
NodeId
string
否
节点 id
IsCompleted
bool
否
流程是否完成，该字段取值为 查询流程实例详情 出参 IsCompleted
PageType
string
是
页面类型。
TODO：待办
DONE：已办
CREATE：创建
CC：抄送
DRAFT：草稿
TaskId
string
是
任务 id
UserInfo
UserInfo
是
当前登录用户信息
Id
string
否
抄送 id，PageType 为 CC 时需要，查询流程实例详情 出参的 CcId

返回参数

字段
类型
描述
VariableInfos
VariableInfo
业务数据结果（页面输入变量信息）
ShowSubmitApp
bool
是否展示提交审批按钮
ShowCarbonCopy
bool
是否展示抄送按钮
ShowTurnToPerson
bool
是否展示转办按钮
ShowAddAssignee
bool
是否展示加签按钮
ShowRollBack
bool
是否显示回退按钮
ShowRevoke
bool
是否显示撤销按钮
OutEntityCodes
list<OutputParamSign>
页面输出变量信息

VariableInfo

字段
类型
描述
ObejctListMap
list<ObjectListResponse>
对象列表集合
ObjectMap
list<ObjectResponse>
对象集合

ObjectListResponse

字段
类型
描述
EntityCode
string
数据源标识
OutputKey
string
变量 Key
FieldValueMapList
list<map<string，object>>
变量 kv 映射列表

ObjectResponse

字段
类型
描述
EntityCode
string
数据源标识
OutputKey
string
变量 Key
FieldValueMap
list<string，object>
变量 kv 映射列表

OutputParamSign

字段
类型
描述
EntityCode
string
数据源标识
Type
string
页面输出变量类型
VariableKey
string
变量 key

Body 参数示例

{
    "InstanceId": "1554350593668153346",
    "FlowCode": "1554326000705142787",
    "NodeId": "handleNode1658806779773",
    "IsCompleted": true,
    "PageType": "DONE",
    "TaskId": "1554350738698797074"
}

返回参数示例

{
    "Response": {
        "Data": {
            "VariableInfos": {
                "ObjectListMap": [],
                "ObjectMap": [
                    {
                        "entityCode": "kongtest_92tbnf0",
                        "RecordId": "",
                        "OutputKey": "handleNode1658740983395outputKey#165874102370210647",
                        "FieldValueMap": {
                            "date": 1661875200000,
                            "test": "1",
                            "num": "1"
                        },
                    }
                ]
            },
            "ShowSubmitApp": false,
            "ShowCarbonCopy": false,
            "ShowTurnToPerson": false,
            "ShowAddAssignee": false,
            "ShowRollBack": false,
            "ShowRevoke": false,
            "OutEntityCodes": [
                {
                    "EntityCode": "kongtest_92tbnf0",
                    "Type": "object",
                    "VariableKey": "kt3"
                }
            ],
        }
    }
}

11. 查询流程画布详情

说明
本接口对应企业工作台审批页面获取流程画布详情，用于渲染流程图示。



请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/GetProcessCanvasInfo

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应资源未发布）
prod：正式环境（对应资源已发布）

Body 参数

字段
类型
是否必填
描述
InstanceId
string
是
流程实例 id
FlowCode
string
否
流程内部编码
NeedUserExtraInfo
bool
否
是否返回处理人用户详细信息

返回参数

字段
类型
描述
Nodes
list<CanvasNode>
节点信息
Edges
list<CanvasEdge>
边信息
UserExtraInfos
list<UserExtraInfo>
处理人用户详细信息

CanvasNode

字段
类型
描述
Id
int
节点序号
ElementId
string
节点 id
Name
string
节点名称
DataType
int
节点类型
Status
int
状态：
1：已完成
2：未开始
3：正在处理
Conf
list<Processor>
配置信息

CanvasEdge

字段
类型
描述
Label
string
分支、边名称
Type
int
类型
Source
string
边的起始节点
Target
string
边的目标节点
Status
int
边的状态：
1：已完成
2：未开始
3：正在处理

Processor

字段
类型
描述
Name
string
处理人名称
Status
int
处理状态：
0：待办
1：提交
2：同意
3：拒绝
4：转办
5：撤销
6：回退
7：加签
8：终止
9：跳过
OpTime
long
操作时间，示例：1689091200000
Comment
string
评论
NewProcessors
string
转交处理人

Body 参数

 {
    "FlowCode": "1554326000705142787",
    "InstanceId": "1554350593668153346",
}

返回参数示例

{
    "Response": {
        "Data": {
            "Nodes": [
                {
                    "visited": true,
                    "Id": 2,
                    "ElementId": "approvalNode1658740549804",
                    "Name": "审批节点",
                    "DataType": 17,
                    "Status": 1,
                    "Conf": [
                        {
                            "Name": "administrator",
                            "Status": 1,
                            "OpTime": 1659421050000,
                            "Comment": null,
                            "NewProcessors": "true"
                        }
                    ]
                },
                {
                    "visited": true,
                    "Id": 3,
                    "ElementId": "handleNode1658740983395",
                    "Name": "处理节点",
                    "DataType": 23,
                    "Status": 1,
                    "Conf": [
                        {
                            "Name": "administrator",
                            "Status": 13,
                            "OpTime": 1659421069000,
                            "Comment": "",
                            "NewProcessors": ""
                        }
                    ]
                },
                {
                    "visited": true,
                    "Id": 4,
                    "ElementId": "handleNode1658806779773",
                    "Name": "处理节点2",
                    "DataType": 23,
                    "Status": 1,
                    "Conf": [
                        {
                            "Name": "administrator",
                            "Status": 13,
                            "OpTime": 1659421086000,
                            "Comment": "",
                            "NewProcessors": ""
                        }
                    ]
                },
                {
                    "visited": true,
                    "Id": 1,
                    "ElementId": "startNode",
                    "Name": "开始",
                    "DataType": 1,
                    "Status": 1,
                    "Conf": null
                },
                {
                    "visited": true,
                    "Id": 5,
                    "ElementId": "endNode",
                    "Name": "结束",
                    "DataType": 13,
                    "Status": 1,
                    "Conf": null
                }
            ],
            "Edges": [
                {
                    "Label": "",
                    "Type": 2,
                    "Source": "handleNode1658806779773",
                    "Target": "endNode",
                    "Status": 2
                },
                {
                    "Label": "",
                    "Type": 2,
                    "Source": "handleNode1658740983395",
                    "Target": "handleNode1658806779773",
                    "Status": 2
                },
                {
                    "Label": "提交申请",
                    "Type": 2,
                    "Source": "approvalNode1658740549804",
                    "Target": "handleNode1658740983395",
                    "Status": 2
                },
                {
                    "Label": "",
                    "Type": 2,
                    "Source": "startNode",
                    "Target": "approvalNode1658740549804",
                    "Status": 2
                }
            ]
        }
    }
}

12. 根据类型查询流程实例列表

说明
本接口对应企业工作台拉取各类审批任务列表。



请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ListProcessInstances

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应资源未发布）
prod：正式环境（对应资源已发布）

Body 参数

字段
类型
是否必填
描述
UserInfo
UserInfo
是
当前用户信息
PageType
string
是
页面类型：
TODO：待办
DONE：已办
CREATE：创建
CC：抄送
DRAFT：草稿
PageNumber
int
否
页码，默认1
PageSize
int
否
页面大小，默认10
Filter
filter
否
筛选条件
Sort
string
否
start_time：根据流程发起时间排序，支持 PageType 包括 TODO、DONE、CREATE、CC、DRAFT
task_start_time：根据任务发起时间排序，支持 PageType 包括 TODO、DONE
cc_time：根据任务抄送时间排序，支持 PageType 包括 CC
task_end_time：根据任务结束时间排序，支持 PageType 为 DONE
Order
string
否
desc：倒序，asc：正序
NeedUserExtraInfo
bool
否
是否返回发起人、审批人用户详细信息
Filter:
字段
类型
描述
FlowName
string
流程标题关键字
FlowStarter
string
流程发起人 id
ProcessKeyList
list<string>
流程标识列表
ApproveStatus
int
审批状态。
1：流转中（只有审批中）
2：已结束（流程审批通过、拒绝、废弃）
3：已终止（只有终止）
FlowGroupList
list<string>
流程分组列表
FlowStartTime
int
流程发起区间的开始时间
FlowEndTime
int
流程发起区间的结束时间
DealStartTime
int
任务处理区间的开始时间，PageType=DONE 时使用
DealEndTime
int
任务处理区间的结束时间，PageType=DONE 时使用

返回参数

字段
类型
描述
Records
list<ProcessInstance>
返回结果
TotalCount
int
总数
PageSize
int
页面大小
PageNumber
int
页号
Pages
int
总页数
FirstPage
bool
是否是第一页
LastPage
bool
是否是最后一页

ProcessInstance

字段
类型
描述
InstanceId
string
流程实例 id
Name
string
流程名称
Description
string
流程描述
StartedBy
string
创建人
StartUserId
string
创建人 id
CanRevoke
bool
是否允许撤回
CcTime
long
抄送时间，示例：1689091200000
CcId
string
抄送 id
CurrentApprover
string
当前审批人
StartTime
long
流程开始时间，示例：1688918400000
EndTime
long
流程结束时间，示例：1689091200000
IsCompleted
bool
审批是否完成
CurrentNodeId
string
任务所属审批节点 id
CurrentNodeName
string
任务所属审批节点名称
CurrentNodeType
int
任务所属审批节点类型
ApprovalNodeName
string
当前正在审批节点名称，IsCompleted=true 时为空
ApprovalNodeId
string
当前正在审批节点 id，同上
TaskId
string
审批节点的任务 id
FlowCode
string
流程定义的 FlowCode
FlowVersion
string
流程定义的版本
CanApprove
bool
是否具有审批权限
CanDelete
bool
是否能够删除流程实例
TaskStartTime
int
任务发起时间
TaskWaitTime
int
任务等待时间
TaskDealTime
int
任务处理时间
Status
int
流程结束状态。
1：终止
2：驳回
3：同意，该字段为空即流程未结束
BeSubmitNode
bool
是否是提交节点
PageTransitionUrl
string
页面跳转 URL
UserExtraInfos
list<UserExtraInfo>
发起人、审批人用户详细信息

Body 参数示例

 {
    "UserInfo": {
        "UserId": "1519239780903088129",
        "Type": 4
    },
    "PageNumber": 1,
    "PageSize": 10,
    "PageType": "TODO"
}

返回参数示例

{
    "Response": {
        "Data": {
            "Records": [
                {
                    "InstanceId": "1554430936495865858",
                    "Name": "administrator提交的kong页面预发测试复用",
                    "Description": "kong页面预发测试复用",
                    "StartedBy": "administrator",
                    "CanRevoke": false,
                    "CcTime": null,
                    "CcId": null,
                    "CurrentApprover": "",
                    "StartTime": 1659440190000,
                    "EndTime": 0,
                    "IsCompleted": false,                    "CurrentNodeId": "handleNode1658740983395",
                    "CurrentNodeName": "处理节点",
                    "CurrentNodeType": null,
                    "TaskId": "1554431187151667201",
                    "FlowCode": "1554326000705142787",
                    "FlowVersion": "27.0",
                    "CanApprove": false,
                    "CanDelete": null,                   
                    "TaskStartTime": 1659440250000,
                    "TaskWaitTime": 60971032,
                    "TaskDealTime": null,
                    "TaskDealResult": 0,
                    "OperationName": "处理",
                    "UserTaskType": 2,
                    "Status": null,
                    "BeSubmitNode": false,
                    "Buttons": {
                        "2": "处理"
                    },
                    "BeRead": true, 
                    "IsSupportBatchHandle": true
                },
                {
                    "InstanceId": "1554411407090827265",
                    "Name": "administrator提交的kong页面预发测试复用",
                    "Description": "kong页面预发测试复用",
                    "StartedBy": "administrator",
                    "CanRevoke": false,
                    "CcTime": null,
                    "CcId": null,
                    "CurrentApprover": "",
                    "StartTime": 1659435534000,
                    "EndTime": 0,
                    "IsCompleted": false,
                    "CurrentNodeId": "handleNode1658740983395",
                    "CurrentNodeName": "处理节点",
                    "CurrentNodeType": null,
                    "TaskId": "1554411501026459650",
                    "FlowCode": "1554326000705142787",
                    "FlowVersion": "27.0",
                    "CanApprove": false,
                    "CanDelete": null,      
                    "TaskStartTime": 1659435556000,
                    "TaskWaitTime": 65665034,
                    "TaskDealTime": null,
                    "TaskDealResult": 0,
                    "OperationName": "处理",
                    "UserTaskType": 2,
                    "Status": null,
                    "BeSubmitNode": false,
                    "Buttons": {
                        "2": "处理"
                    },
                    "BeRead": true,
                    "IsSupportBatchHandle": true
                }          
            ],
            "TotalCount": 35,
            "PageSize": 10,
            "PageNumber": 1,
            "Pages": 4,
            "FirstPage": true,
            "LastPage": false
        }
    }
}

13. 根据类型查询流程实例总数

说明
本接口对应企业工作台拉取各类审批任务个数。



请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ListProcessInstancesCount

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应资源未发布）
prod：正式环境（对应资源已发布）

Body 参数

字段
类型
是否必填
描述
UserInfo
UserInfo
是
当前用户信息
PageType
string
否
页面类型：
TODO：待办
DONE：已办
CREATE：创建
CC：抄送
DRAFT：草稿

返回参数

字段
类型
描述
TotalCounts
list<TotalCountByType>
流程实例总数列表

TotalCountByType

字段
类型
描述
Total
int
流程实例总数
PageType
string
页面类型

Body 参数示例

{
    "UserInfo": {
        "UserId": "1519239780903088129",
        "Type": 4
    },
    "PageType": "TODO"

返回参数示例

{
    "Response": {
        "RequestId": "kongtest-777",
        "Data": {
            "TotalCounts": [
                {
                    "Total": 17,
                    "PageType": "DONE",
                },
                {
                    "Total": 35,
                    "PageType": "TODO",
                },
                {
                    "Total": 2,
                    "PageType": "DRAFT",
                },
                {
                    "Total": 10,
                    "PageType": "CC",
                },
                {
                    "Total": 51,
                    "PageType": "CREATE",
                }
            ]
        }
    }
}

14. 提交流程审批任务列表

说明
本接口对应企业工作台审批时指定下一节点审批人，假设流程配置包含 审批节点A -> 审批节点 B，审批节点 B 配置了上一节点指定审批人，审批节点 A 调用 完成审批任务 完成审批后，需要调用本接口指定审批节点 B 的审批人。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/SubmitFlowTaskList

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
FlowTaskIds
list<string>
是
待提交审批任务 id 列表，值为 完成审批任务 出参 WaitFlowTaskId

返回参数

字段
类型
描述
Result
bool
操作结果

Body 参数示例

{
    "FlowTaskIds": [
        "1575337230827069442",
        "1575337230827069444"
    ]
}

返回参数示例

{
    "Response": {
        "RequestId": "e9caa0f9bf0b9",
        "Data": {
            "Result": true
        }
    }
}

15. 催办

说明
审批任务一天最多可催办3次，第二天次数重置。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/PressTask

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
InstanceId
string
是
流程实例 id

返回参数

字段
类型
描述
Result
bool
操作结果

Body 参数示例

{
  "InstanceId": "1580800040917700609"
}

返回参数示例

{
    "Response": {
        "RequestId": "e9caa0f9bf0b9",
        "Data": {
            "Result": true
        }
    }
}

16. 撤销

说明
撤销功能需要在人工节点高级属性中开启，审批开始节点高级属性可配置发起人撤销，非审批开始节点、处理节点可配置审批人撤销。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/Revoke

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
TaskId
string
是
当前审批任务 id
Revoker
UserInfo
是
撤销人信息
RevokerType
int
是
撤销类型。
1：审批人撤销
2：发起人撤销
Comment
string
否
撤销意见

返回参数

字段
类型
描述
Result
bool
操作结果

Body 参数示例

{
  "Revoker": {
    "UserId": "1558049980829474819",
    "Type": 4
  },
  "TaskId": "1580772187253673985",
  "RevokeType": 1
}

返回参数示例

{
    "Response": {
        "RequestId": "e9caa0f9bf0b9",
        "Data": {
            "Result": true
        }
    }
}

17. 加签

说明
加签功能一般用于会签场景，需要在人工节点高级属性中开启。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/AddCounterSignAssignee

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
TaskId
string
是
当前审批任务 id
Approver
UserInfo
是
当前审批人信息
AssigneeIds
list<string>
是
加签人列表
Comment
string
否
加签意见

返回参数

字段
类型
描述
Result
bool
操作结果

Body 参数示例

{
  "Approver": {
    "UserId": "1558049980829474819",
    "Type": 4
  },
  "TaskId": "1580756089389092866",
  "AssigneeIds": ["1559148626461061122"]
}

返回参数示例

{
    "Response": {
        "RequestId": "e9caa0f9bf0b9",
        "Data": {
            "Result": true
        }
    }
}

18. 获取可回退的节点列表

说明
本接口在回退操作前调用，获取当前流程可以回退的审批节点列表。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/GetPreElementList

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
InstanceId
string
是
流程实例 id
NodeId
string
否
节点 id

返回参数

字段
类型
描述
ElementInfoList
list<ElementiInfo>
可回退的节点列表信息

ElementInfo

字段
类型
描述
ElementId
string
节点 id
ElementName
string
节点名称
ActTaskId
string
审批任务 id
ApproveType
int
1：审批开始节点
2：非审批开始节点
LastNode
bool
是否为最后一个节点

Body 参数示例

{
  "InstanceId": "1580763678206234626"
}

返回参数示例

{
    "Response": {
        "RequestId": "108b2329b9521",
        "Data": {
            "ElementInfoList": [
                {
                    "ElementId": "approvalNode1661763351191",
                    "ElementName": "审批节点1",
                    "ActTaskId": "1582268451725860868",
                    "ApproveType": 2,
                    "LastNode": true
                },
                {
                    "ElementId": "approvalNode1660217576658",
                    "ElementName": "审批节点",
                    "ActTaskId": "1582268388094210050",
                    "ApproveType": 1,
                    "LastNode": false
                }
            ]
        }
    }
}

19. 回退

说明
回退功能需要在人工节点高级属性中开启，调用该接口前，需要先调用 接口18：获取可回退的节点列表 获取可回退的节点列表。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/RollBack

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
UserInfo
UserInfo
是
当前审批人
TaskId
string
是
当前审批任务 id，即当前要回退的任务id
TargetNodeId
string
是
回退到之前节点的节点 id，对应接口18出参ElementId
TargetActTaskId
string
是
回退到之前节点的ActTaskId，对应接口18出参ActTaskId
Comment
string
否
回退意见

返回参数

字段
类型
描述
Result
bool
操作结果

Body 参数示例

{
  "UserInfo": {
    "UserId": "1558049980829474819",
    "Type": 4
  },
  "TaskId": "1580763839900848130",
  "TargetNodeId": "approvalNode1660217576658",
  "TargetActTaskId": "1580763678239789057"
}

返回参数示例

{
    "Response": {
        "RequestId": "e9caa0f9bf0b9",
        "Data": {
            "Result": true
        }
    }
}

20. 查询消息列表

说明
该接口对应企业工作台消息中心列表。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/DescribeWorkflowMessages

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
UserInfo
UserInfo
是
当前登录用户信息
PageNo
int
是
页面编号，从1开始
PageSize
int
是
页面大小，最大200
SearchTitleName
string
否
消息标题搜索关键字
MessageType
int
否
消息类型：
0：待办
2：站内信
Status
string
否
消息状态。
READ_DONE：已读
READ_TODO：未读

返回参数

字段
类型
描述
TotalCount
int
消息总条数
ResponseList
list<MessageContent>
消息列表

MessageContent

字段
类型
描述
MessageType
int
消息类型：
0：待办
2：站内信
MainTitle
string
主标题
SubTitle
string
子标题
MessageText
string
消息内容
MessagePageLink
string
消息页面地址
MessageId
string
消息 id
CreateTime
string
创建时间
UpdateTime
string
更新时间

Body 参数示例

{
  "UserInfo": {
    "UserId": "1558049980829474819",
    "Type": 4
  },
  "PageNo": 1,
  "PageSize": 10,
  "SearchTitleName": "",
  "MessageType": 0,
  "Status": "READ_DONE"
}

返回参数示例

{
    "Response": {
        "RequestId": "1bf0c8e1180d6",
        "Data": {
            "TotalCount": 188,
            "ResponseList": [
                {
                    "MessageType": 0,
                    "MainTitle": "处理提醒",
                    "SubTitle": "处理提醒",
                    "MessageText": "kongtest，请尽快处理流程kongprod，有人等急了哦！",
                    "MessagePageLink": "https://lowcode-1gk9y5ik310a94df-1307578329.tcloudbaseapp.com/adminportal/#/app/app-1bfche6y-preview/udud5ucot9?envType=preview&flowTaskId=1582268470990434306&pageType=TODO",
                    "MessageId": "1582268587512393730",
                    "Status": "READ_TODO",
                    "CreateTime": "2022-10-18T15:13:23.000+0800",
                    "UpdateTime": "2022-10-18T15:13:23.000+0800"
                }
            ]
        }
    }
}

21. 查询消息个数

说明
该接口对应企业工作台消息中心展示消息个数。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/DescribeWorkflowMessageCount

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
UserInfo
UserInfo
是
当前登录用户信息
MessageType
int
是
消息类型：
0：待办
2：站内信

返回参数

字段
类型
描述
Result
list<MessageCount>
消息个数

MessageCount

字段
类型
描述
MessageType
int
消息类型
WaitingCount
int
待处理消息数
FinishCount
int
已处理消息数

Body 参数示例

{
  "UserInfo": {
    "UserId": "1558049980829474819",
    "Type": 4
  },
  "MessageType": 0
}

返回参数示例

{
    "Response": {
        "RequestId": "a9991b4c52b03",
        "Data": {
            "Result": [
                {
                    "MessageType": 0,
                    "WaitingCount": 175,
                    "FinishCount": 13
                }
            ]
        }
    }
}

22. 更新消息状态

说明
该接口对应企业工作台消息中心修改消息状态。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/UpdateWorkflowMessageStatus

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
UserInfo
UserInfo
是
当前登录用户
MessageIdList
list<string>
是
消息 id 列表
Status
string
是
更新消息状态。
READ_DONE：已读
READ_TODO：未读

返回参数

字段
类型
描述
Result
bool
操作结果

Body参数示例

{
  "UserInfo": {
    "UserId": "1558049980829474819",
    "Type": 4
  },
  "MessageIdList": ["1580041268610727937"],
  "Status": "READ_DONE"
}

返回参数示例

{
    "Response": {
        "RequestId": "e9caa0f9bf0b9",
        "Data": {
            "Result": true
        }
    }
}

23. 批办过程查询

说明
该接口对应审批页面查询批办流程记录，渲染为流程记录。



请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/GetInstanceOperation

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
InstanceId
string
是
流程实例 id
NeedUserExtraInfo
bool
否
是否返回处理人用户详细信息

返回参数

字段
类型
描述
ElementInfos
list<ElementInfo>
节点流转记录列表
UserExtraInfos
list<UserExtraInfo>
处理人用户详细信息

ElementInfo

字段
类型
描述
Name
string
节点名称
OperaName
list<string>
操作人名称列表
OperaUserList
list<info>
操作人列表
Result
string
操作结果
ContentInfo
ContentEntity
操作内容

ContentEntity

字段
类型
描述
Action
string
操作动作：
1：提交
2：同意
3：拒绝
4：转办
5：撤销
6：回退
7：加签
8：终止
9：跳过
13：处理
15：节点抄送
16：废弃流程
17：保存草稿
IsCC
bool
是否为审批节点操作
Operation
string
操作记录
OperationComment
string
审批意见
CcUserInfos
list<info>
抄送人员列表
CreateTime
long
操作时间
OpinionUserMap
map<string，string>
@操作，userid 和@用户名映射
Operation 值为 json 字符串。
动作编号
动作名称
描述
json 字符串示例
5
撤销
撤销文案
"审批人撤销" 或 "发起人撤销"
7
会签
会签人的 json 字符串，类型为 list<info>
"[{\\"id\\":\\"1526534489242292225\\",\\"name\\":\\"zhihhwang\\"}]"
其他
-
-
空

info

字段
类型
描述
id
string
用户 UserId
Name
string
用户名称
审批操作展示逻辑： Result='待审批' 或 Result='待处理' 时，审批操作展示 Result 的值。 其他情况通过 ContentInfo.Action 展示审批操作。

Body参数示例

{
    "InstanceId": "1620626326290259969"
}

返回参数示例

{
    "code":0,
    "data":{
        "Response":{
            "RequestId":"49dc3f03c610d",
            "Data":{
                "ElementInfos":[
                    {
                        "OperaUserList":[
                            {
                                "Id":"1558049980829474819",
                                "Name":"kongtest"
                            }
                        ],
                        "OperaName":[
                            "kongtest"
                        ],
                        "ContentInfo":{
                            "Action":2,
                            "CreateTime":1686625416000,
                            "IsCC":null,
                            "Operation":null,
                            "OpinionUserMapJsonStr":null,
                            "CcUserInfos":[

                            ],
                            "OperationComment":"3333"
                        },
                        "Id":"1668454038108676098",
                        "Name":"审批节点",
                        "Result":"true"
                    },
                    {
                        "OperaUserList":[
                            {
                                "Id":"1558049980829474819",
                                "Name":"kongtest"
                            }
                        ],
                        "OperaName":[
                            "kongtest"
                        ],
                        "ContentInfo":{
                            "Action":15,
                            "CreateTime":1686625416000,
                            "IsCC":false,
                            "Operation":null,
                            "OpinionUserMapJsonStr":null,
                            "CcUserInfos":[
                                {
                                    "Id":"1558049980829474819",
                                    "Name":"kongtest"
                                }
                            ],
                            "OperationComment":null
                        },
                        "Id":"1668454038511329282",
                        "Name":"抄送节点",
                        "Result":null
                    }
                ]
            }
        }
    }
}

24. 删除草稿

说明
该接口对应企业工作台流程中心草稿箱删除草稿。



请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/DeleteDraftProcessInstance

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
InstanceId
string
是
流程实例 id
TaskId
string
是
任务 id
UserInfo
UserInfo
是
当前操作人

返回参数

字段
类型
描述
Status
bool
是否删除成功

Body 参数示例

{
    "InstanceId": "1654039818191388673",
    "TaskId": "1654039818380132353",
    "UserInfo": {
        "UserId": "1558049980829474819",
        "Type": 4
     }
}

返回参数示例

{
    "Response": {
        "RequestId": "4f0c58a4f3f69",
        "Data": {
            "Status": false
        }
    }
}

25. 查询流程实例审批人、发起人列表

说明
该接口对应企业工作台流程中心、管理后台 查询发起人、审批人列表。






请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/DescribeInstanceApproverList
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/DescribeInstanceStarterList

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
NeedUserExtraInfo
bool
否
是否返回审批人、发起人详细信息

返回参数

字段
类型
描述
Data
list<InstanceUserInfo>
审批人、发起人列表

InstanceUserInfo

字段
类型
描述
Uid
string
审批人、发起人 id
Name
string
审批人、发起人名称
UserExtraInfo
UserExtraInfo
审批人、发起人详细信息

Body 参数示例

{
    "NeedUserExtraInfo": true
}

返回参数示例

{
    "Response": {
        "RequestId": "d992637188e22",
        "Data": [
            {
                "Uid": "1526534489242292225",
                "Name": "bbb"
            },
            {
                "Uid": "1522849562653122561",
                "Name": "aaa"
            },
            {
                "Uid": "1615977281052733441",
                "Name": "ccc"
            }
        ]
    }
}

26. 获取审批流列表

说明
本接口对应企业工作台 > 流程中心 > 发起流程中展示的流程列表。 这里流程列表只展示满足以下条件的流程，并非全部流程：
1. 流程开始节点未配置输入变量。
2. 流程第一个审批节点为审批开始节点。
3. 当前登录用户有该审批流程的权限。



请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/DescribeAppProcessList

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
UserInfo
userInfo
是
当前登录人
KeyWords
string
否
搜索关键字

返回参数

字段
类型
描述
InitiateProcessList
list<AppFlowsDetails>
流程及应用列表

AppFlowsDetails

字段
类型
描述
DefaultGroup
list<InitiateProcess>
默认分组
AppFlowsGroup
list<AppFlowsGroup>
应用流程分组
AppName
string
应用名称
AppCode
string
应用标识

InitiateProcess

字段
类型
描述
FlowCode
string
流程编码
ProcessKey
string
流程标识
Name
string
流程名称
CollectFlag
int
是否收藏。
0：否
1：是

AppFlowsGroup

字段
类型
描述
FlowGroupName
string
流程分组名称
FlowGroupCode
long
流程分组 code
FlowDetails
list<InitiateProcess>
流程信息列表

Body 参数示例

{
    "UserInfo": {
        "UserId": "1558049980829474819",
        "Type": 4
     }
}

返回参数示例

{
    "Response": {
        "RequestId": "5f20d5bcfd218",
        "Data": {
            "InitiateProcessList": [
                {
                    "DefaultGroup": [
                        {
                            "AppCode": "1",
                            "FlowCode": "1553937645695393794",
                            "ProcessKey": "flow_ftwl1bx",
                            "Name": "黄晓强测试流程003",
                            "Version": "15.0",
                            "CollectFlag": 0,
                            "ProcDeployId": 1553937646152572929,
                            "IsBeginWithParams": "false"
                        }
                    ],
                    "AppFlowsGroups": [],
                    "AppCode": "app-acvtrjfj",
                    "AppName": "HXQ模型应用_0729"
                },
                {
                    "DefaultGroup": [],
                    "AppFlowsGroups": [
                        {
                            "FlowGroupName": "wxbFlowGroup",
                            "FlowGroupCode": 1555473552218652675,
                            "FlowDetails": [
                                {
                                    "AppCode": "1",
                                    "FlowCode": "1642782064771104770",
                                    "ProcessKey": "flow_pnycwiv",
                                    "Name": "wxb默认测试流程",
                                    "Version": "25.0",
                                    "CollectFlag": 1,
                                    "ProcDeployId": 1642782065123426305,
                                    "IsBeginWithParams": "false",
                                    "FlowGroupCode": 1555473552218652675
                                }
                            ]
                        }
                    ],
                    "AppCode": "app-u89evwis",
                    "AppName": "模型应用_整体测试"
                }
            ]
        }
    }
}

27. 获取收藏的审批流列表

说明
本接口对应企业工作台 > 流程中心 > 发起流程中收藏的流程列表。



请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/DescribeCollectAppProcessList

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
UserInfo
UserInfo
是
当前登录人
KeyWords
string
否
搜索关键字

返回参数

字段
类型
描述
InitiateProcessList
list<AppFlowsDetails>
流程及应用列表

AppFlowsDetails

字段
类型
描述
FlowDetails
list<InitiateProcess>
默认分组
AppName
string
应用名称
AppCode
string
应用标识

Body 参数示例

{
    "UserInfo": {
        "UserId": "1558049980829474819",
        "Type": 4
     }
}

返回参数示例

{
    "Response": {
        "RequestId": "a3293622a88e5",
        "Data": {
            "InitiateProcessList": [
                {
                    "FlowDetails": [
                        {
                            "AppCode": "1",
                            "FlowCode": "1555473605415010306",
                            "ProcessKey": "flow_yiv1u3x",
                            "Name": "kong页面预发测试复用副本",
                            "Version": "1.0",
                            "CollectFlag": 1,
                            "ProcDeployId": 1562046262046007297,
                            "IsBeginWithParams": "false",
                            "FlowGroupCode": 1555473552218652675
                        }
                    ],
                    "AppCode": "app-sqw1qr9t",
                    "AppName": "odata 测试"
                }
           ]
        }
    }
}

28. 收藏流程

说明
本接口对应企业工作台 > 流程中心 > 发起流程中收藏流程操作。



请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/CollectProcess

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
ProcessKey
string
是
流程标识
CollectFlag
int
是
是否收藏 ：
0：否
1：是
UserInfo
UserInfo
是
当前操作人

返回参数

字段
类型
描述
CollectFlag
int
是否收藏成功 ：
0：否
1：是

Body 参数示例

{
    "ProcessKey": "flow_pnycwiv",
    "CollectFlag": 1,
    "UserInfo": {
        "UserId": "1558049980829474819",
        "Type": 4
     }
}

返回参数示例

{
    "Response": {
        "RequestId": "38cdccc5aaa74",
        "Data": {
            "CollectFlag": 1
        }
    }
}

29. 管理后台获取实例列表

说明
本接口对应企业工作台 > 系统设置 > 流程管理中展示流程实例列表。



请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/DescribeProcessManageInstances

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

说明：
入参为小驼峰。
字段
类型
是否必填
描述
pageSize
int
否
页面大小，默认10
pageNo
int
否
页码，默认1
orderBy
string
否
排序属性，start_time：按照实例发起时间排序
orderType
string
否
排序规则。
desc：倒序（默认）
asc：正序
filter
Filter
否
过滤条件
userInfo
UserInfo
是
当前操作人
needUserExtraInfo
bool
否
是否返回操作人用户详细信息

Filter

字段
类型
含义
FlowName
String
流程标题关键字
FlowStarterList
list<string>
流程发起人 id 列表
CurrentApproverList
list<string>
流程审批人 id 列表
ProcessKeyList
list<string>
流程标识列表
ApproveStatus
int
审批状态。
1：流转中（只有审批中）
2：已结束（流程审批通过、拒绝、废弃）
3：已终止（只有终止）
FlowGroupList
list<string>
流程分组列表
FlowStartTime
int
流程发起区间的开始时间时间戳
FlowEndTime
int
流程发起区间的结束时间时间戳

返回参数

字段
类型
描述
records
list<ManageInstance>
管理后台实例列表
ManageInstance
字段
类型
描述
InstanceId
string
流程实例 id
Name
string
流程标题
StartedBy
string
发起人名称
CurrentApprover
string
当前审批人，以 , 分割
StartTime
int
流程实例发起时间
EndTime
int
流程实例结束时间
CurrentNodeId
string
当前审批节点 id
CurrentNodeName
string
当前审批节点名称
ApproveStatus
int
审批状态
FlowCode
string
流程编码
FlowVersion
string
流程版本
ProcessKey
string
流程标识
UserExtraInfos
list<UserExtraInfo>
操作人用户详细信息

Body 参数示例

{
    "pageNo": 1,
    "pageSize": 3,
    "orderBy": "start_time",
    "orderType": "asc",
    "filter": {
        "FlowName": "kongtest1",
        "ApproveStatus": 2
    },
    "userInfo": {
        "UserId": "1558049980829474819",
        "Type": 4
    }
}

返回参数示例

{
    "records": [
        {
            "InstanceId": "1554744048959025153",
            "Name": "administrator提交的kongtest1",
            "StartedBy": "",
            "CurrentApprover": "",
            "StartTime": 1659514843000,
            "EndTime": 1659514864697,
            "CurrentNodeId": "",
            "CurrentNodeName": "",
            "ApproveStatus": 2,
            "FlowCode": "1554743879884996610",
            "FlowVersion": "2.0",
            "ProcessKey": "flow_021",
            "_id": "1554744048959025153"
        },
        {
            "InstanceId": "1555464781915541505",
            "Name": "administrator提交的kongtest1",
            "StartedBy": "",
            "CurrentApprover": "",
            "StartTime": 1659686679000,
            "EndTime": 1680752525298,
            "CurrentNodeId": "",
            "CurrentNodeName": "",
            "ApproveStatus": 2,
            "FlowCode": "1554746726240866307",
            "FlowVersion": "3.0",
            "ProcessKey": "flow_021",
            "_id": "1555464781915541505"
        },
        {
            "InstanceId": "1555464860365803521",
            "Name": "administrator提交的kongtest1",
            "StartedBy": "",
            "CurrentApprover": "",
            "StartTime": 1659686697000,
            "EndTime": 1663817493856,
            "CurrentNodeId": "",
            "CurrentNodeName": "",
            "ApproveStatus": 2,
            "FlowCode": "1554746726240866307",
            "FlowVersion": "3.0",
            "ProcessKey": "flow_021",
            "_id": "1555464860365803521"
        }
    ],
    "total": 35,
    "pageSize": 3,
    "pageNo": 1,
    "requestId": "94f3f909fd6c4"
    }

30. 管理后台实例操作列表

说明
本接口对应企业工作台 > 系统设置 > 流程管理中展示流程实例操作列表。



请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/DescribeProcessManageInstanceOperation

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
NodeId
string
是
当前节点 id
InstanceId
string
是
流程实例 id
UserInfo
UserInfo
是
当前操作人

返回参数

字段
类型
描述
CanRollBack
bool
是否可以回退
CanRevoke
bool
是否可以撤销
CanTurnTask
bool
是否可以转办
CanSkip
bool
是否可以跳过

Body 参数示例

{
    "InstanceId": "1659127010815275009",
    "NodeId": "approvalNode1679553458359",
    "UserInfo": {
        "UserId": "1558049980829474819",
        "Type": 4
    }
}

返回参数示例

{
    "Response": {
        "RequestId": "44aa034ddb3fe",
        "Data": {
            "CanRollBack": true,
            "CanRevoke": false,
            "CanTurnTask": true,
            "CanSkip": true
        }
    }
}

31. 管理后台实例任务列表

说明
本接口对应企业工作台 > 系统设置 > 流程管理中点击某一流程操作，展示的任务列表。



请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/DescribeManageInstanceTaskList

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
InstanceId
string
是
流程实例 id
UserInfo
UserInfo
是
当前操作人
NeedUserExtraInfo
bool
否
是否返回审批人用户详细信息

返回参数

字段
类型
描述
TaskList
list<ManageTask>
管理后台任务列表
UserExtraInfo
list<UserExtraInfo>
审批人用户详细信息
ManageTask
字段
类型
描述
NodeName
string
节点名称
NodeId
string
节点 id
TaskId
string
任务 id
TaskStatus
int
任务状态：
1：待办
2：同意
3：拒绝
4：转办
Assignee
string
审批人名称
StartTime
int
任务开始时间
EndTime
int
任务结束时间

Body 参数示例

{
    "InstanceId": "1679422724690472962",
    "UserInfo": {
        "UserId": "1558049980829474819",
        "Type": 4
     }
}


返回参数示例

{
    "Response": {
        "RequestId": "f14cec2a5571a",
        "Data": {
            "TaskList": [
               {
                    "NodeName": "审批节点b2",
                    "NodeId": "approvalNode1679553458359",
                    "TaskId": "1683772692872503297",
                    "TaskStatus": 1,
                    "Assignee": "kongtest",
                    "StartTime": 1690277668000
                },
                {
                    "NodeName": "审批节点b3",
                    "NodeId": "approvalNode1679553039308",
                    "TaskId": "1659127330345742339",
                    "TaskStatus": 3,
                    "Assignee": "kongtest",
                    "StartTime": 1684401755000,
                    "EndTime": 1684401776542
                },
                {
                    "NodeName": "处理节点",
                    "NodeId": "handleNode1672371262590",
                    "TaskId": "1659127012073566209",
                    "TaskStatus": 2,
                    "Assignee": "kongtest",
                    "StartTime": 1684401679000,
                    "EndTime": 1684401709304
                }
            ]
        }
    }
}


32. 管理后台跳过操作

说明
本接口对应企业工作台 > 系统设置 > 流程管理操作列表的跳过操作。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ManageSkipTask

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
InstanceId
string
是
实例 id
TaskId
string
是
任务 id
ButtonAction
int
是
操作选项。
1：提交
2：同意
3：拒绝
UserInfo
UserInfo
是
当前操作人
Comment
string
否
跳过意见

返回参数

字段
类型
描述
Status
bool
是否跳过成功

Body 参数示例

{
    "InstanceId": "1679422724690472962",
    "TaskId": "1681560241249259522",
    "ButtonAction": 2,
    "UserInfo": {
        "UserId": "1558049980829474819",
        "Type": 4
     }
}

返回参数示例

{
    "Response": {
        "RequestId": "38cdccc5aaa74",
        "Data": {
            "Status": false
        }
    }
}

33. 管理后台撤销操作

说明
本接口对应企业工作台 > 系统设置 > 流程管理操作列表的撤销操作。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ManageRevokeProcessList

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
InstanceIdList
list<string>
是
流程实例 id 列表
UserInfo
UserInfo
是
当前操作人
Comment
string
否
撤销意见

返回参数

字段
类型
描述
RevokeResponseList
list<RevokeResp>
是否撤销成功
RevokeResp
字段
类型
描述
InstanceId
string
实例 id
IsCanRevoke
bool
是否可以撤销
RevokeStatus
bool
撤销结果

Body 参数示例

{
    "InstanceIdList": [
        "1679422724690472962"
    ],
    "UserInfo": {
        "UserId": "1558049980829474819",
        "Type": 4
     }
}

返回参数示例

{
    "Response": {
        "RequestId": "38cdccc5aaa74",
        "Data": {
            "RevokeResponseList": [
                 {
                     "InstanceId": "1659127330345742339",
                     "IsCanRevoke": true,
                     "RevokeStatus": true
                 }
            ]
        }
    }
}

34. 管理后台终止操作

说明
本接口对应企业工作台 > 系统设置 > 流程管理操作列表的终止操作。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ManageStopProcessList

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
InstanceIdList
list<string>
是
流程实例 id 列表
UserInfo
UserInfo
是
当前操作人

返回参数

字段
类型
描述
Status
bool
是否终止成功

Body 参数示例

{
    "InstanceIdList": [
        "1679422724690472962"
    ],
    "UserInfo": {
        "UserId": "1558049980829474819",
        "Type": 4
     }
}

返回参数示例

{
    "Response": {
        "RequestId": "38cdccc5aaa74",
        "Data": {
            "Status": false
        }
    }
}

35. 管理后台作废操作

说明
本接口对应企业工作台 > 系统设置 > 流程管理操作列表的作废操作。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ManageAbandonProcessList

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
InstanceIdList
list<string>
是
流程实例 id 列表
UserInfo
UserInfo
是
当前操作人

返回参数

字段
类型
描述
Status
bool
是否作废成功

Body 参数示例

{
    "InstanceIdList": [
        "1679422724690472962"
    ],
    "UserInfo": {
        "UserId": "1558049980829474819",
        "Type": 4
     }
}

返回参数示例

{
    "Response": {
        "RequestId": "38cdccc5aaa74",
        "Data": {
            "Status": false
        }
    }
}

36. 管理后台转办操作

说明
本接口对应企业工作台 > 系统设置 > 流程管理操作列表的转办操作。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ManageTurnTask

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
InstanceId
string
是
实例 id
TaskId
string
是
任务 id
TurnToUserId
string
是
转办目标人 id
UserInfo
UserInfo
是
当前操作人
Comment
string
否
转办意见

返回参数

字段
类型
描述
Status
bool
是否转办成功

Body 参数示例

{
    "InstanceId": "1678612486675296257",
    "TaskId": "1678612489120575490",
    "TurnToUserId": "1558049980829474819",
    "UserInfo": {
        "UserId": "1558049980829474819",
        "Type": 4
     }
}

返回参数示例

{
    "Response": {
        "RequestId": "38cdccc5aaa74",
        "Data": {
            "Status": false
        }
    }
}

37. 管理后台回退操作

说明
本接口对应企业工作台 > 系统设置 > 流程管理操作列表的回退操作。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ManageRollBackTask

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
TaskId
string
是
任务 id
TargetNodeId
string
是
目标节点 id
TargetActTaskId
string
是
目标 ActTaskId
UserInfo
UserInfo
是
当前操作人
Comment
string
否
回退意见

返回参数

字段
类型
描述
Status
bool
是否回退成功

Body 参数示例

{
  "TaskId": "1678651685923254273",
  "TargetNodeId": "approvalNode1673407379378",
  "TargetActTaskId": "1678651542943625223",
  "UserInfo": {
        "UserId": "1558049980829474819",
        "Type": 4
     }
}

返回参数示例

{
    "Response": {
        "RequestId": "38cdccc5aaa74",
        "Data": {
            "Status": true
        }
    }
}

38. 管理后台删除操作

说明
本接口对应企业工作台 > 系统设置 > 流程管理操作列表的删除操作。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ManageStopAndClearProcessInstance

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

Body 参数

字段
类型
是否必填
描述
InstanceId
string
是
实例 id
UserInfo
UserInfo
是
当前操作人

返回参数

字段
类型
描述
Status
bool
是否删除成功

Body 参数示例

{
    "InstanceId": "1678612486675296257",
    "UserInfo": {
        "UserId": "1558049980829474819",
        "Type": 4
     }
}

返回参数示例

{
    "Response": {
        "RequestId": "38cdccc5aaa74",
        "Data": {
            "Status": true
        }
    }
}

39. 查询流程分组

说明
本接口用于展示控制台流程分组列表。
请求方式：POST
请求地址：
https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/DescribeFlowGroupFolders

Query 参数

字段
类型
是否必填
描述
envType
string
是
weda 环境类型。
pre：预览环境（对应流程未发布）
prod：正式环境（对应流程已发布）

返回参数

字段
类型
描述
GroupFolders
list<GroupFolder>
流程分组列表
GroupFolder
字段
类型
描述
GroupName
string
分组名称
GroupId
string
分组 id

Body 参数示例

{}

返回参数示例

{
    "Response": {
        "RequestId": "c9f9271c124bd",
        "Data": {
            "GroupFolders": [
                {
                    "GroupName": "zhihhwang",
                    "GroupId": "1534138536125050881"
                }
           ]
        }
    }
}

中国站
文档反馈
文档活动
message-icon联系我们
目录