https://cic_irc.yuque.com/tyl581/ggwv9w/ltiq62kcppa58u2n
1. 流程接口文档
1.1启动流程
1**.1.1****接口说明:**
Facade:FlowProcessRpcFacade
Method:startProcessByName
1**.1.2****请求参数说明**
| 参数名 | 必选 | 类型 | 参数说明 |
| flowName | Y | string | 流程名称 |
| businessNumber | Y | string | 业务单号 |
| businessType | N | string | 业务单类型 |
| uniqueCode | N | String | 唯一标识(与业务单号组合使用) |
| variables | N | Map<String,Object> | 流程变量 |
| priority | N | Integer | 优先级 |
| parentId | N | string | 父流程 |
| subTaskTag | N | string | 协助子任务名称标识 |
| messageTag | N | string | 自定义个性化MQ消息tag |
1**.1.3****返回参数说明:**
| 参数名 | 参数说明 |
| status | 状态(1=成功,2=失败) |
| message | 信息 |
1.2终止流程
1**.2.1****接口说明:**
Facade:FlowProcessRpcFacade
Method:terminateProcess
1**.2.2****请求参数说明**
| 参数名 | 必选 | 类型 | 参数说明 |
| instanceId | Y | string | 流程实例Id |
1**.2.3****返回参数说明:**
| 参数名 | 参数说明 |
| status | 状态(1=成功,2=失败) |
| message | 信息 |
1.3设置流程变量
1**.3.1****接口说明:**
Facade:FlowProcessRpcFacade
s****Method:setFlowVariables
1**.3.2****请求参数说明**
| 参数名 | 必选 | 类型 | 参数说明 |
| instanceId | Y | string | 流程实例Id |
| variables | Y | Map<String,Object> | 要配置的流程变量 |
1**.3.3****返回参数说明:**
| 参数名 | 参数说明 |
| status | 状态(1=成功,2=失败) |
| message | 信息 |
1.4获取下一用户任务信息
1**.4.1****接口说明:**
Facade:FlowProcessRpcFacade
Method:getNextTaskInfo
1**.4.2****请求参数说明**
| 参数名 | 必选 | 类型 | 参数说明 |
| taskId | Y | string | 任务实例Id |
1**.4.3****返回参数说明:**
| 参数名 | 参数说明 |
| status | 状态(1=成功,2=失败) |
| message | 信息 |
| taskName | 用户任务名称 |
| expression | 用户任务对应条件表达式 |
2. 任务接口文档
2**.1指派任务**
2.1.1****接口说明:
Facade:TaskRpcFacade
Method:assign
2.1.2****请求参数说明
| 参数名 | 必选 | 类型 | 参数说明 |
| taskId | Y | string | 任务实例id |
| assignee | Y | string | 任务受理人账号Id |
| assigneeType | Y | Integer | 受理人类型(0:组,1:人) |
2.2.3****返回参数说明:
| 参数名 | 参数说明 |
| status | 状态(1=成功,2=失败) |
| message | 信息 |
2**.**2 任务审批
2.2.1****接口说明:
Facade:TaskRpcFacade
Method:complete
2.2.2****请求参数说明
| 参数名 | 必选 | 类型 | 参数说明 |
| taskId | Y | string | 任务实例id |
| condition | Y | Integer | 审核条件(1.-任务通过,2任务拒绝,3任务退回) |
| taskComment | N | string | 审批意见(任务拒绝时必填) |
| currentUserId | Y | String | 审批人 |
| nextAssignee | N | String | 下一个用户任务的受理人 |
2.2.3****返回参数说明:
| 参数名 | 参数说明 |
| status | 状态(1=成功,2=失败) |
| message | 信息 |
2**.**3 任务接收
2.3.1****接口说明:
Facade:TaskRpcFacade
Method:receive
2.3.2****请求参数说明
| 参数名 | 必选 | 类型 | 参数说明 |
| taskId | Y | string | 任务实例id |
| currentUserId | Y | String | 当前操作人 |
2.3.3****返回参数说明:
| 参数名 | 参数说明 |
| status | 状态(1=成功,2=失败) |
| message | 信息 |
2**.**4 撤回接口
2.4.1****接口说明:
Facade:TaskRpcFacade
Method:withdraw
2.4.2****请求参数说明
| 参数名 | 必选 | 类型 | 参数说明 |
| taskId | Y | string | 任务实例id |
| currentUserId | Y | String | 当前操作人 |
| withdrawTaskCondition | Y | Integer | 撤回选项(0:撤回到上一个任务节点,1:撤回到申请人) |
2.4.3****返回参数说明:
| 参数名 | 参数说明 |
| status | 状态(1=成功,2=失败) |
| message | 信息 |
2**.**5 任务转派
2.5.1****接口说明:
Facade:TaskRpcFacade
Method:reassign
2.5.3****请求参数说明
| 参数名 | 必选 | 类型 | 参数说明 |
| taskId | Y | List | 任务实例id |
| assignee | Y | String | 任务新受理人 |
| assigneeType | Y | Integer | 受理人类别(0:工作组,1:人) |
| currentUserId | Y | String | 当前操作人 |
2.5.4****返回参数说明:
| 参数名 | 参数说明 |
| status | 状态(1=成功,2=失败) |
| message | 信息 |
2**.**6 挂起任务
2.6.1****接口说明:
Facade:TaskRpcFacade
Method:suspend
2.6.2****请求参数说明
| 参数名 | 必选 | 类型 | 参数说明 |
| taskId | Y | String | 任务实例id |
2.6.3****返回参数说明:
| 参数名 | 参数说明 |
| status | 状态(1=成功,2=失败) |
| message | 信息 |
2**.**7 恢复任务
2.7.1****接口说明:
Facade:TaskRpcFacade
Method:active
2.7.2****请求参数说明
| 参数名 | 必选 | 类型 | 参数说明 |
| taskId | Y | String | 任务实例id |
2.7.3****返回参数说明:
| 参数名 | 参数说明 |
| status | 状态(1=成功,2=失败) |
| message | 信息 |
**3.**工作组接口文档
3.1 查询工作组详情
3.1.1****接口说明:
Facade:GroupRpcFacade
Method:GroupRpcFacade.getGroupById
3.1.2****请求参数说明
QueryGroupBO:
| 参数名 | 必选 | 类型 | 参数说明 |
| id | Y | Long | id |
3.1.3****返回参数说明:
| 参数名 | 类型 | 参数说明 |
| status | string | 状态(1=成功,2=失败) |
| message | string | 信息 |
| totalCount | string | 总条数 |
| GroupDTO | Object | 查询对象 |
| pageIndex | Integer | 分页页码 |
| pageSize | Integer | 分页大小 |
GroupDTO:
| 参数名 | 类型 | 参数说明 |
| Id | string | 任务实例ID |
| createBy | string | 任务名称 |
| gmtCreate | string | 业务单号 |
| modifiedBy | string | 任务编码(流程实例ID) |
| gmtModified | string | 任务处理人 |
| tenant | string | 任务状态(1-待处理/2-处理中/3-已拒绝/4-已完成/5-已撤回/6-已退回上个节点/7-已退回申请人/8-退回待处理/9-到组待认领) |
| name | Integer | 任务类型(具体业务尚未提供) |
| leaderId | Integer | 任务创建时间 |
| leaderName | Date | 任务修改时间 |
| domain | integer | 任务优先级(0-高/1-中/2-低) |
| product | TaskDomainDTO | 子任务信息 |
| taskType | String | 任务类型 |
| businessType | String | 业务类型 |
| Businessdimension | String | 业务维度 |
| overflowId | String | 互溢组Id |
| overflowName | String | 互溢组名称 |
| personDailyWorkload | int | 每人每日工作量 |
| groupTagBOList | List | 工作组标签列表 |
GroupTagDTO:
| 参数名 | 类型 | 参数说明 |
| workGroupId | string | 工作组ID |
| tagName | String | 标签名字 |
| tagValue | String | 标签值 |
| codeType | String | 标签对应码表type(标签数据类型为码表时有效) |
| tagCode | String | 标签对应码值code(标签数据类型为码表时有效) |
3.2 查询组员列表
3.2.1****接口说明:
Facade:GroupRpcFacade
Method:GroupRpcFacade.listMembersByGroupId
3.2.2****请求参数说明
QueryGroupBO:
| 参数名 | 必选 | 类型 | 参数说明 |
| id | Y | Long | id |
3.2.3****返回参数说明:
| 参数名 | 类型 | 参数说明 |
| status | string | 状态(1=成功,2=失败) |
| message | string | 信息 |
| totalCount | string | 总条数 |
| List | GroupPersonnelDTO | 组员列表 |
| pageIndex | Integer | 分页页码 |
| pageSize | Integer | 分页大小 |
GroupPersonnelDTO:
| 参数名 | 类型 | 参数说明 |
| personnelId | Long | 人员Id |
| groupId | string | 工作组ID |
| personnelStatus | Integer | 人员状态 |
| createBy | string | 最近创建人 |
| modifiedBy | string | 最近修改者 |
| gmtCreate | Date | 任务创建时间 |
| gmtModified | Date | 任务修改时间 |
3.3 通过标签查询工作组
3.3.1****接口说明:
Facade:GroupRpcFacade
Method:GroupRpcFacade.listGroupByGroupTag
3.3.2****请求参数说明
listGroupByGroupTagBO:
| 参数名 | 必选 | 类型 | 参数说明 |
| List | Y | GroupTagBO | 标签列表 |
GroupTagBO:
| 参数名 | 必选 | 类型 | 参数说明 |
| tagName | Y | String | 标签名字 |
| tagValue | Y | String | 标签值 |
3.3.3****返回参数说明:
| 参数名 | 类型 | 参数说明 |
| status | string | 状态(1=成功,2=失败) |
| message | string | 信息 |
| totalCount | string | 总条数 |
| GroupDTO | Object | 查询对象 |
| pageIndex | Integer | 分页页码 |
| pageSize | Integer | 分页大小 |
GroupDTO:
| 参数名 | 类型 | 参数说明 |
| Id | string | 任务实例ID |
| createBy | string | 任务名称 |
| gmtCreate | string | 业务单号 |
| modifiedBy | string | 任务编码(流程实例ID) |
| gmtModified | string | 任务处理人 |
| tenant | string | 任务状态(1-待处理/2-处理中/3-已拒绝/4-已完成/5-已撤回/6-已退回上个节点/7-已退回申请人/8-退回待处理/9-到组待认领) |
| name | Integer | 任务类型(具体业务尚未提供) |
| leaderId | Integer | 任务创建时间 |
| leaderName | Date | 任务修改时间 |
| domain | integer | 任务优先级(0-高/1-中/2-低) |
| product | TaskDomainDTO | 子任务信息 |
| taskType | String | 任务类型 |
| businessType | String | 业务类型 |
| Businessdimension | String | 业务维度 |
| overflowId | String | 互溢组Id |
| overflowName | String | 互溢组名称 |
| personDailyWorkload | int | 每人每日工作量 |
| groupTagBOList | List | 工作组标签列表 |
GroupTagDTO:
| 参数名 | 类型 | 参数说明 |
| workGroupId | string | 工作组ID |
| tagName | String | 标签名字 |
| tagValue | String | 标签值 |
| codeType | String | 标签对应码表type(标签数据类型为码表时有效) |
| tagType | String | 标签对应码值code(标签数据类型为码表时有效) |
3.4 新增标签
3.4.1****接口说明:
Facade:GroupRpcFacade
Method:GroupRpcFacade.insertTag
3.4.2****请求参数说明
insertTagBO:
| 参数名 | 必选 | 类型 | 参数说明 |
| tag | Y | String | 标签变量 |
| tagDataType | Y | String | 标签数据类型(0/1:码表/字符串) |
| tagName | Y | String | 标签名字 |
| tagType | Y | String | 标签库类型(0:工作组) |
| code | N | String | 码表(标签数据类型为码表时必填) |
| operatorAccId | Y | String | 操作者账户id |
3.4.3****返回参数说明:
| 参数名 | 参数说明 |
| status | 状态(1=成功,2=失败) |
| message | 信息 |
3.5 新增工作组
3.5.1****接口说明:
Facade:GroupRpcFacade
Method:GroupRpcFacade.insertGroup
3.5.2****请求参数说明
GroupBO:
| 参数名 | 必选 | 类型 | 参数说明 | |
| operatorAccId | Y | String | 操作者账户ID | |
| personDailyWorkload | Y | Integer | 每人每日工作量 | |
| overFlowId | N | Long | 互溢组Id | |
| domain | Y | String | 领域 | |
| businessType | Y | String | 业务类型 | |
| name | Y | String | 工作组名称 | |
| leaderId | Y | String | 组长ID(组长必须包含在组员内) | |
| leaderName | Y | String | 组长名称 | |
| memberIds | Y | List | 组员Id | |
| groupTagBOList | Y | List | 标签列表 | |
| mechanism | Y | String | 机构 | |
| status | Y | String | 0/1:正常/已删除 |
GroupTagBO:
| 参数名 | 必选 | 类型 | 参数说明 |
| tagName | Y | String | 标签名字 |
| tagValue | Y | String | 标签值 |
| codeType | N | String | 标签对应码表type(标签数据类型为码表时有效) |
| tagCode | N | String | 标签对应码值code(标签数据类型为码表时有效) |
3.5.3请求报文:
| { “domain”: “16”, “operatorAccId”: “140”, “businessType”: “5”, “name”: “支撑”, “personDailyWorkload”: 12, “leaderId”: “99”, “leaderName”: “运营支撑域管理员”, “status”: “0”, “mechanism”: “210100000000,213700000000,213703000000,213703030000,223703030200”, “product”: “P0101,P0102”, “memberIds”: [ “99” ], “groupTagBOList”: [ { “tagName”: “ceshi” } ] } |
3.5.4****返回参数说明:
| 参数名 | 参数说明 |
| status | 状态(1=成功,2=失败) |
| message | 信息 |
**4.**调度服务接口文档
4.1 调度服务
4.1.1****接口说明:
Facade:DispatchRpcFacade
Method:DispatchRpcFacade.dispatchService
4.1.2****请求参数说明
DispatchServiceBO:
| 参数名 | 必选 | 类型 | 参数说明 |
| groupTags | N | Map<String,String> | 工作组标签列 |
| code | Y | String | 调度策略编码 |
| groups | N | List | 指定处理组ID列 |
4.1.3****返回参数说明:
| 参数名 | 类型 | 参数说明 |
| accountId | string | 人员账户ID |
| groupId | string | 工作组ID |