From a2b9bd685a0ccfb0fc4449275cb5f2434e876302 Mon Sep 17 00:00:00 2001 From: vickytong123 <108515634+vickytong123@users.noreply.github.com> Date: Thu, 24 Aug 2023 15:11:48 +0800 Subject: [PATCH] =?UTF-8?q?Update=20=E5=B7=A5=E4=BD=9C=E6=B5=81.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../\345\267\245\344\275\234\346\265\201.md" | 1404 ++++++++++++++++- 1 file changed, 1400 insertions(+), 4 deletions(-) diff --git "a/product/\347\247\273\345\212\250\344\270\216\351\200\232\344\277\241/\344\272\221\345\274\200\345\217\221\344\275\216\344\273\243\347\240\201\345\271\263\345\217\260/API \346\226\207\346\241\243/\345\267\245\344\275\234\346\265\201 OpenAPI/\346\234\215\345\212\241\347\253\257API/\345\267\245\344\275\234\346\265\201.md" "b/product/\347\247\273\345\212\250\344\270\216\351\200\232\344\277\241/\344\272\221\345\274\200\345\217\221\344\275\216\344\273\243\347\240\201\345\271\263\345\217\260/API \346\226\207\346\241\243/\345\267\245\344\275\234\346\265\201 OpenAPI/\346\234\215\345\212\241\347\253\257API/\345\267\245\344\275\234\346\265\201.md" index 19a20de1ffb0..75f5f3c1ba43 100644 --- "a/product/\347\247\273\345\212\250\344\270\216\351\200\232\344\277\241/\344\272\221\345\274\200\345\217\221\344\275\216\344\273\243\347\240\201\345\271\263\345\217\260/API \346\226\207\346\241\243/\345\267\245\344\275\234\346\265\201 OpenAPI/\346\234\215\345\212\241\347\253\257API/\345\267\245\344\275\234\346\265\201.md" +++ "b/product/\347\247\273\345\212\250\344\270\216\351\200\232\344\277\241/\344\272\221\345\274\200\345\217\221\344\275\216\344\273\243\347\240\201\345\271\263\345\217\260/API \346\226\207\346\241\243/\345\267\245\344\275\234\346\265\201 OpenAPI/\346\234\215\345\212\241\347\253\257API/\345\267\245\344\275\234\346\265\201.md" @@ -2649,22 +2649,32 @@ Filter：区间开始时间和区间结束时间需成对使用 CurrentNodeId string -当前审批节点 ID +任务所属审批节点id ID CurrentNodeName string -当前审批节点名称 +任务所属审批节点名称 CurrentNodeType int -当前审批节点类型 +任务所属审批节点类型 + + +ApprovalNodeName +string +当前正在审批节点名称，IsCompleted=true时为空 + + +ApprovalNodeId +string +当前正在审批节点Id，同上 TaskId string -当前审批节点的任务 ID +审批节点的任务 ID FlowCode @@ -4971,4 +4981,1390 @@ https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ ::: +### 管理后台获取实例列表 +- 请求方式：POST +- 请求地址： +```html +https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/DescribeProcessManageInstances +``` + +#### Query 参数 + + + + + + + + + + + + + + +
字段类型是否必填描述
envTypestring是weda 环境类型，pre：预览环境（对应流程未发布），prod：正式环境（对应流程已发布）
+ + +#### Body 参数 + +入参为小驼峰 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
字段类型是否必填描述
pageSizeint否页面大小 默认10
pageNoint否页码 默认1
orderBystring否排序属性 start_time：按照实例发起时间排序
orderTypestring否排序规则 desc：倒序（默认） asc：正序
filterFilter否过滤条件
userInfoUserInfo是当前操作人
+ +#### Filter + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
字段类型含义
FlowNameString流程标题关键字
FlowStarterListlist<string>流程发起人Id列表
CurrentApproverListlist<string>流程审批人Id列表
ProcessKeyListlist<string>流程标识列表
ApproveStatusint审批状态 +1：流转中(只有审批中) +2：已结束(流程审批通过、拒绝、废弃) +3：已终止(只有终止) +
FlowGroupListlist<string>流程分组列表
FlowStartTimeint流程发起区间的开始时间时间戳
FlowEndTimeint流程发起区间的结束时间时间戳
+ +#### 返回参数 + + + + + + + + + + + + +
字段类型描述
recordslist<ManageInstance>管理后台实例列表
+ +##### ManageInstance + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
字段类型描述
InstanceIdstring流程实例Id
Namestring流程标题
StartedBystring发起人名称
CurrentApproverstring当前审批人，以,分割
StartTimeint流程实例发起时间
EndTimeint流程实例结束时间
CurrentNodeIdstring当前审批节点id
CurrentNodeNamestring当前审批节点名称
ApproveStatusint审批状态
FlowCodestring流程编码
FlowVersionstring流程版本
ProcessKeystring流程标识
+ +#### Body 参数示例 + +::: js +{ + "pageNo": 1, + "pageSize": 3, + "orderBy": "start_time", + "orderType": "asc", + "filter": { + "FlowName": "kongtest1", + "ApproveStatus": 2 + }, + "userInfo": { + "UserId": "1558049980829474819", + "Type": 4 + } +} +::: + + + +#### 返回参数示例 + +::: js +{ + "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" + } +::: + + +### 管理后台实例操作列表 +- 请求方式：POST +- 请求地址： +```html +https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/DescribeProcessManageInstanceOperation +``` + +#### Query 参数 + + + + + + + + + + + + + + +
字段类型是否必填描述
envTypestring是weda 环境类型，pre：预览环境（对应流程未发布），prod：正式环境（对应流程已发布）
+ + +#### Body 参数 + + + + + + + + + + + + + + + + + + + + + + + + + + +
字段类型是否必填描述
NodeIdstring是当前节点Id
InstanceIdstring是流程实例Id
UserInfoUserInfo是当前操作人
+ + +#### 返回参数 + + + + + + + + + + + + + + + + + + + + + + + + +
字段类型描述
CanRollBackbool是否可以回退
CanRevokebool是否可以撤销
CanTurnTaskbool是否可以转办
CanSkipbool是否可以跳过
+ +#### Body 参数示例 + +::: js +{ + "InstanceId": "1659127010815275009", + "NodeId": "approvalNode1679553458359", + "UserInfo": { + "UserId": "1558049980829474819", + "Type": 4 + } +} + +::: + + + +#### 返回参数示例 + +::: js +{ + "Response": { + "RequestId": "44aa034ddb3fe", + "Data": { + "CanRollBack": true, + "CanRevoke": false, + "CanTurnTask": true, + "CanSkip": true + } + } +} +::: + + +### 管理后台实例任务列表 +- 请求方式：POST +- 请求地址： +```html +https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/DescribeManageInstanceTaskList +``` + +#### Query 参数 + + + + + + + + + + + + + + +
字段类型是否必填描述
envTypestring是weda 环境类型，pre：预览环境（对应流程未发布），prod：正式环境（对应流程已发布）
+ + +#### Body 参数 + + + + + + + + + + + + + + + + + + + + +
字段类型是否必填描述
InstanceIdstring是流程实例Id
UserInfoUserInfo是当前操作人
+ + +#### 返回参数 + + + + + + + + + + + + +
字段类型描述
TaskListlist<ManageTask>管理后台任务列表
+ +##### ManageTask + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
字段类型描述
NodeNamestring节点名称
NodeIdstring节点Id
TaskIdstring任务Id
TaskStatusint任务状态：1待办、2同意、3拒绝、4转办
Assigneestring审批人名称
StartTimeint任务开始时间
EndTimeint任务结束时间
+ +#### Body 参数示例 + +::: js +{ + "InstanceId": "1679422724690472962", + "UserInfo": { + "UserId": "1558049980829474819", + "Type": 4 + } +} +::: + + + +#### 返回参数示例 + +::: js +{ + "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 + } + ] + } + } +} +::: + + +### 管理后台跳过操作 +- 请求方式：POST +- 请求地址： +```html +https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ManageSkipTask +``` + +#### Query 参数 + + + + + + + + + + + + + + +
字段类型是否必填描述
envTypestring是weda 环境类型，pre：预览环境（对应流程未发布），prod：正式环境（对应流程已发布）
+ + +#### Body 参数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
字段类型是否必填描述
InstanceIdstring是实例Id
TaskIdstring是任务Id
ButtonActionint是操作选项，1：提交，2：同意，3：拒绝
UserInfoUserInfo是当前操作人
+ + +#### 返回参数 + + + + + + + + + + + + +
字段类型描述
Statusbool是否跳过成功
+ +#### Body 参数示例 + +::: js +{ + "InstanceId": "1679422724690472962", + "TaskId": "1681560241249259522", + "ButtonAction": 2, + "UserInfo": { + "UserId": "1558049980829474819", + "Type": 4 + } +} +::: + + + +#### 返回参数示例 + +::: js +{ + "Response": { + "RequestId": "38cdccc5aaa74", + "Data": { + "Status": false + } + } +} +::: + + +### 管理后台撤销操作 +- 请求方式：POST +- 请求地址： +```html +https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ManageRevokeProcessList +``` + +#### Query 参数 + + + + + + + + + + + + + + +
字段类型是否必填描述
envTypestring是weda 环境类型，pre：预览环境（对应流程未发布），prod：正式环境（对应流程已发布）
+ + +#### Body 参数 + + + + + + + + + + + + + + + + + + + + +
字段类型是否必填描述
InstanceIdListlist<string>是流程实例Id列表
UserInfoUserInfo是当前操作人
+ + +#### 返回参数 + + + + + + + + + + + + +
字段类型描述
RevokeResponseListlist<RevokeResp>是否撤销成功
+ +##### RevokeResp + + + + + + + + + + + + + + + + + + + + + + +
字段类型描述
InstanceIdstring实例Id
IsCanRevokeboolean是否可以撤销
RevokeStatusboolean撤销结果
+ +#### Body 参数示例 + +::: js +{ + "InstanceIdList": [ + "1679422724690472962" + ], + "UserInfo": { + "UserId": "1558049980829474819", + "Type": 4 + } +} +::: + + + +#### 返回参数示例 + +::: js +{ + "Response": { + "RequestId": "38cdccc5aaa74", + "Data": { + "RevokeResponseList": [ + { + "InstanceId": "1659127330345742339", + "IsCanRevoke": true, + "RevokeStatus": true + } + ] + } + } +} +::: + + +### 管理后台终止操作 +- 请求方式：POST +- 请求地址： +```html +https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ManageStopProcessList +``` + +#### Query 参数 + + + + + + + + + + + + + + +
字段类型是否必填描述
envTypestring是weda 环境类型，pre：预览环境（对应流程未发布），prod：正式环境（对应流程已发布）
+ + +#### Body 参数 + + + + + + + + + + + + + + + + + + + + +
字段类型是否必填描述
InstanceIdListlist<string>是流程实例Id列表
UserInfoUserInfo是当前操作人
+ + +#### 返回参数 + + + + + + + + + + + + +
字段类型描述
Statusbool是否终止成功
+ +#### Body 参数示例 + +::: js +{ + "InstanceIdList": [ + "1679422724690472962" + ], + "UserInfo": { + "UserId": "1558049980829474819", + "Type": 4 + } +} +::: + + + +#### 返回参数示例 + +::: js +{ + "Response": { + "RequestId": "38cdccc5aaa74", + "Data": { + "Status": false + } + } +} +::: + + +### 管理后台作废操作 +- 请求方式：POST +- 请求地址： +```html +https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ManageAbandonProcessList +``` + +#### Query 参数 + + + + + + + + + + + + + + +
字段类型是否必填描述
envTypestring是weda 环境类型，pre：预览环境（对应流程未发布），prod：正式环境（对应流程已发布）
+ + +#### Body 参数 + + + + + + + + + + + + + + + + + + + + +
字段类型是否必填描述
InstanceIdListlist<string>是流程实例Id列表
UserInfoUserInfo是当前操作人
+ + +#### 返回参数 + + + + + + + + + + + + +
字段类型描述
Statusbool是否作废成功
+ +#### Body 参数示例 + +::: js +{ + "InstanceIdList": [ + "1679422724690472962" + ], + "UserInfo": { + "UserId": "1558049980829474819", + "Type": 4 + } +} +::: + + + +#### 返回参数示例 + +::: js +{ + "Response": { + "RequestId": "38cdccc5aaa74", + "Data": { + "Status": false + } + } +} +::: + + +### 管理后台转办操作 +- 请求方式：POST +- 请求地址： +```html +https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ManageTurnTask +``` + +#### Query 参数 + + + + + + + + + + + + + + +
字段类型是否必填描述
envTypestring是weda 环境类型，pre：预览环境（对应流程未发布），prod：正式环境（对应流程已发布）
+ + +#### Body 参数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
字段类型是否必填描述
InstanceIdstring是实例Id
TaskIdstring是任务Id
TurnToUserIdstring是转办目标人Id
UserInfoUserInfo是当前操作人
+ + +#### 返回参数 + + + + + + + + + + + + +
字段类型描述
Statusbool是否转办成功
+ +#### Body 参数示例 + +::: js +{ + "InstanceId": "1678612486675296257", + "TaskId": "1678612489120575490", + "TurnToUserId": "1558049980829474819", + "UserInfo": { + "UserId": "1558049980829474819", + "Type": 4 + } +} +::: + + + +#### 返回参数示例 + +::: js +{ + "Response": { + "RequestId": "38cdccc5aaa74", + "Data": { + "Status": false + } + } +} +::: + + +### 管理后台回退操作 +- 请求方式：POST +- 请求地址： +```html +https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ManageRollBackTask +``` + +#### Query 参数 + + + + + + + + + + + + + + +
字段类型是否必填描述
envTypestring是weda 环境类型，pre：预览环境（对应流程未发布），prod：正式环境（对应流程已发布）
+ + +#### Body 参数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
字段类型是否必填描述
TaskIdstring是任务Id
TargetNodeIdstring是目标节点Id
TargetActTaskIdstring是目标ActTaskId
UserInfoUserInfo是当前操作人
+ + +#### 返回参数 + + + + + + + + + + + + +
字段类型描述
Statusbool是否回退成功
+ +#### Body 参数示例 + +::: js +{ + "TaskId": "1678651685923254273", + "TargetNodeId": "approvalNode1673407379378", + "TargetActTaskId": "1678651542943625223", + "UserInfo": { + "UserId": "1558049980829474819", + "Type": 4 + } +} +::: + + + +#### 返回参数示例 + +::: js +{ + "Response": { + "RequestId": "38cdccc5aaa74", + "Data": { + "Status": true + } + } +} +::: + + +### 管理后台删除操作 +- 请求方式：POST +- 请求地址： +```html +https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/ManageStopAndClearProcessInstance +``` + +#### Query 参数 + + + + + + + + + + + + + + +
字段类型是否必填描述
envTypestring是weda 环境类型，pre：预览环境（对应流程未发布），prod：正式环境（对应流程已发布）
+ + +#### Body 参数 + + + + + + + + + + + + + + + + + + + + +
字段类型是否必填描述
InstanceIdstring是实例Id
UserInfoUserInfo是当前操作人
+ + +#### 返回参数 + + + + + + + + + + + + +
字段类型描述
Statusbool是否删除成功
+ +#### Body 参数示例 + +::: js +{ + "InstanceId": "1678612486675296257", + "UserInfo": { + "UserId": "1558049980829474819", + "Type": 4 + } +} +::: + + + +#### 返回参数示例 + +::: js +{ + "Response": { + "RequestId": "38cdccc5aaa74", + "Data": { + "Status": true + } + } +} +::: + + +### 查询流程分组 +- 请求方式：POST +- 请求地址： +```html +https://{envId}.{region}.tcb-api.tencentcloudapi.com/weda/workflow/v1/{envType}/DescribeFlowGroupFolders +``` + +#### Query 参数 + + + + + + + + + + + + + + +
字段类型是否必填描述
envTypestring是weda 环境类型，pre：预览环境（对应流程未发布），prod：正式环境（对应流程已发布）
+ + +#### 返回参数 + + + + + + + + + + + + + +
字段类型描述
GroupFolderslist<GroupFolder>是流程分组列表
+ +##### GroupFolder + + + + + + + + + + + + + + + + + + +
字段类型是否必填描述
GroupNamestring分组名称
GroupIdstring分组Id
+ + +#### Body 参数示例 + +::: js +{} +::: + + + +#### 返回参数示例 + +::: js +{ + "Response": { + "RequestId": "c9f9271c124bd", + "Data": { + "GroupFolders": [ + { + "GroupName": "zhihhwang", + "GroupId": "1534138536125050881" + } + ] + } + } +} + +::: +