敏捷工作流开发平台接口文档
Version information
Version : 1.0
URI scheme
Host : localhost:8080
BasePath : /
Swagger 接口
springboot版本登录后访问本地 地址 http://localhost:8080/swagger-ui.html (目前仅仅springboot版本有整合swagger)
Tags
- 个人办公服务接口 : Bpm My Task Controller
- 在线业务表单服务接口 : Form Data Service Controller
- 流程任务相关服务接口 : Bpm Task Controller
- 流程实例服务接口 : Bpm Instance Controller
- 用户信息服务接口 : User Service Controller
- 用户组服务接口 : Group Service Controller
- 登陆服务接口 : Login Controller
- 登陆用户信息服务接口 : User Resource Controller
Resources
个人办公服务接口
Bpm My Task Controller
我的申请
POST /bpm/my/applyTaskList |
描述
获取我发起过的流程申请，可以查看自己发起的流程执行情况，可查阅自己发起过的所有流程审批
请求入参
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| FormData | filter$VEQ optional |
其他过滤参数，“filter”为数据库过滤字段名，“V”一位代表字段类型，“EQ/IN/LK/..”代表查询类型“等于/in/小于/..” | string | |
| FormData | limit optional |
分页大小 | string | |
| FormData | offset optional |
offset | string | |
| FormData | order optional |
order | string | "ASC" |
| FormData | sort optional |
排序字段 | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResult«BpmInstance» |
Consumes
application/json
Produces
*/*
我的审批
POST /bpm/my/approveList |
描述
获取历史审批过的流程任务 。会展示所有自己办理过的流程、若是候选人未办理则不会展示。 其他过滤参数：“filter”为数据库过滤字段名，“V”一位代表字段类型，“EQ/IN/LK/..”代表查询类型“等于/in/小于/..”
请求入参
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| FormData | filter$VEQ optional |
其他过滤参数 | string | |
| FormData | limit optional |
分页大小 | string | |
| FormData | offset optional |
offset | string | |
| FormData | order optional |
order | string | "ASC" |
| FormData | sort optional |
排序字段 | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResult«BpmTaskApprove» |
Consumes
application/json
Produces
*/*
发起申请
POST /bpm/my/definitionList |
描述
获取自己拥有发起权限的流程列表，用于流程发起。其他过滤参数，“filter”为数据库过滤字段名，“V”一位代表字段类型，“EQ/IN/LK/..”代表查询类型“等于/in/小于/..”
请求入参
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| FormData | filter$VEQ optional |
其他过滤参数 | string | |
| FormData | limit optional |
分页大小 | string | |
| FormData | offset optional |
offset | string | |
| FormData | order optional |
order | string | "ASC" |
| FormData | sort optional |
排序字段 | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResult«BpmDefinition» |
Consumes
application/json
Produces
*/*
我的草稿
POST /bpm/my/draftList |
描述
获取我的草稿，在流程发起页面保存的，且并未提交的流程事项。其他过滤参数：“filter”为数据库过滤字段名，支持subject_,name_，等字段过滤“V”一位代表字段类型，“EQ/IN/LK/..”代表查询类型“等于/in/小于/..”
请求入参
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| FormData | filter$VEQ optional |
其他过滤参数 | string | |
| FormData | limit optional |
分页大小 | string | |
| FormData | offset optional |
offset | string | |
| FormData | order optional |
order | string | "ASC" |
| FormData | sort optional |
排序字段 | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResult«BpmInstance» |
Consumes
application/json
Produces
*/*
我的待办
POST /bpm/my/todoTaskList |
描述
根据当前用户获取个人所有待办，支持对subject_,name_等Task字段过滤，“filter”为数据库过滤字段名,“V”一位代表字段类型,“EQ/IN/LK/..”代表查询类型“等于/in/小于/..”
请求入参
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| FormData | filter$VEQ optional |
过滤参数 | string | |
| FormData | limit optional |
分页大小，默认20条 | string | |
| FormData | offset optional |
offset | string | |
| FormData | order optional |
排序，默认升序 | string | "ASC" |
| FormData | sort optional |
排序字段 | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResult«BpmTask» |
Consumes
application/json
Produces
*/*
在线业务表单服务接口
Form Data Service Controller
获取业务表单的数据
GET /form/formDataService/getData/{formKey}/{id} |
描述
获取业务表单的相关数据：表单业务数据、表单字段权限、表单初始化数据、表单HTML源码
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | formKey required |
表单key | string |
| Path | id optional |
业务数据主键 | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«FormDefData» |
Consumes
application/json
Produces
*/*
获取bo的数据分页列表
POST /form/formDataService/getList/{boKey} |
描述
通过boKey 获取该业务对象下所有的业务数据 -分页，返回 JSON列表
请求入参
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | boKey required |
BoKey | string | |
| FormData | filter$VEQ optional |
其他字段过滤参数 | string | |
| FormData | limit optional |
分页大小 | string | |
| FormData | offset optional |
offset | string | |
| FormData | order optional |
order | string | "ASC" |
| FormData | sort optional |
排序字段 | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResult |
Consumes
application/json
Produces
*/*
通过业务主键删除业务数据
GET /form/formDataService/removeData/{formKey}/{id} |
描述
删除某个业务对象下某一条业务数据，通过表单key,主键ID
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | formKey required |
表单KEY | string |
| Path | id required |
主键ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«string» |
Consumes
application/json
Produces
*/*
保存业务表单的数据
POST /form/formDataService/saveData/{formKey} |
描述
把业务表单的业务数据持久化
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | formKey required |
表单key | string |
| Body | data required |
业务数据JSON | < string, object > map |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«string» |
Consumes
application/json
Produces
*/*
流程任务相关服务接口
Bpm Task Controller
任务指派
POST /bpm/task/assignTask |
描述
管理员将任务指派给某一个用户处理
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | taskId required |
taskId | string |
| Query | userId required |
userId | string |
| Query | userName required |
userName | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«string» |
Consumes
application/json
Produces
*/*
任务指派
GET /bpm/task/assignTask |
描述
管理员将任务指派给某一个用户处理
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | taskId required |
taskId | string |
| Query | userId required |
userId | string |
| Query | userName required |
userName | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«string» |
Consumes
application/json
Produces
*/*
执行任务相关动作
POST /bpm/task/doAction |
描述
执行任务相关的动作 如：同意，驳回，反对，锁定，解锁，转办，会签任务等相关操作
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | flowParam required |
flowParam | FlowRequestParam |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«string» |
Consumes
application/json
Produces
*/*
流程任务
POST /bpm/task/getBpmTask |
描述
获取流程任务信息
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | id required |
任务ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«BpmTask» |
Consumes
application/json
Produces
*/*
流程任务
GET /bpm/task/getBpmTask |
描述
获取流程任务信息
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | id required |
任务ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«BpmTask» |
Consumes
application/json
Produces
*/*
获取流程任务相关数据
POST /bpm/task/getTaskData |
描述
获取任务的业务数据、表单、按钮、权限等信息，为了渲染展示任务页面
请求入参
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Query | formType optional |
表单类型 | string | "pc" |
| Query | taskId required |
任务ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«FlowData» |
Consumes
application/json
Produces
*/*
获取流程任务相关数据
GET /bpm/task/getTaskData |
描述
获取任务的业务数据、表单、按钮、权限等信息，为了渲染展示任务页面
请求入参
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Query | formType optional |
表单类型 | string | "pc" |
| Query | taskId required |
任务ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«FlowData» |
Consumes
application/json
Produces
*/*
流程任务列表
POST /bpm/task/listJson |
描述
获取流程任务的列表数据，用于管理员管理任务，入参“filter”为数据库过滤字段名，支持对title_,name_等任务字段过滤，“V”一位代表字段类型，“EQ/IN/LK/..”代表查询类型“等于/in/小于/..”
请求入参
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| FormData | filter$VEQ optional |
其他过滤参数 | string | |
| FormData | limit optional |
分页大小 | string | |
| FormData | offset optional |
offset | string | |
| FormData | order optional |
order | string | "ASC" |
| FormData | sort optional |
排序字段 | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResult«BpmTask» |
Consumes
application/json
Produces
*/*
任务取消指派
POST /bpm/task/unLock |
描述
管理员将任务取消指派，若任务原先无候选人，则无法取消指派。
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | taskId required |
任务ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«string» |
Consumes
application/json
Produces
*/*
任务取消指派
GET /bpm/task/unLock |
描述
管理员将任务取消指派，若任务原先无候选人，则无法取消指派。
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | taskId required |
任务ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«string» |
Consumes
application/json
Produces
*/*
流程实例服务接口
Bpm Instance Controller
流程实例批量删除
POST /bpm/instance/delete |
描述
实例id以逗号分隔，删除流程实例会删除相关的所有任务数据，也会级联删除业务数据
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | id optional |
流程实例ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«string» |
Consumes
application/json
Produces
*/*
执行流程实例相关动作
POST /bpm/instance/doAction |
描述
流程启动，流程保存草稿，草稿启动，催办，人工终止等流程实例相关的动作请求入口
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | flowParam required |
flowParam | FlowRequestParam |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«string» |
Consumes
application/json
Produces
*/*
获取流程图流文件
GET /bpm/instance/flowImage |
描述
获取流程实例的流程图，以流的形式返回png图片
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | defId optional |
流程定义ID，流程未启动时使用 | string |
| Query | instId optional |
流程实例ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | No Content |
Consumes
application/json
Produces
*/*
流程实例
POST /bpm/instance/getById |
描述
获取流程实例详情信息
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | id optional |
ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«IBpmInstance» |
Consumes
application/json
Produces
*/*
流程实例数据
POST /bpm/instance/getInstanceData |
描述
获取流程实例相关数据，包含实例信息，业务数据，表单权限、表单数据、表单内容等
请求入参
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| FormData | defId optional |
流程定义ID，启动时使用 | string | |
| FormData | flowKey optional |
流程定义Key，启动时使用,与DefId二选一 | string | |
| FormData | formType optional |
表单类型 | string | "pc" |
| FormData | instanceId optional |
流程实例ID | string | |
| FormData | readonly optional |
是否只读实例 | string | "false" |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«FlowData» |
Consumes
application/json
Produces
*/*
流程实例数据
GET /bpm/instance/getInstanceData |
描述
获取流程实例相关数据，包含实例信息，业务数据，表单权限、表单数据、表单内容等
请求入参
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| FormData | defId optional |
流程定义ID，启动时使用 | string | |
| FormData | flowKey optional |
流程定义Key，启动时使用,与DefId二选一 | string | |
| FormData | formType optional |
表单类型 | string | "pc" |
| FormData | instanceId optional |
流程实例ID | string | |
| FormData | readonly optional |
是否只读实例 | string | "false" |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«FlowData» |
Consumes
application/json
Produces
*/*
获取流程意见
POST /bpm/instance/getInstanceOpinion |
描述
通过流程实例ID 获取该流程实例下所有的审批意见、并按处理时间排序
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | instId optional |
流程实例ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«List«BpmTaskOpinion»» |
Consumes
application/json
Produces
*/*
获取流程意见
GET /bpm/instance/getInstanceOpinion |
描述
通过流程实例ID 获取该流程实例下所有的审批意见、并按处理时间排序
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | instId optional |
流程实例ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«List«BpmTaskOpinion»» |
Consumes
application/json
Produces
*/*
流程实例列表
POST /bpm/instance/listJson |
描述
获取流程实例管理列表，用于超管管理流程实例，可以用来干预任务实例
请求入参
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| FormData | filter$VEQ optional |
其他过滤参数 | string | |
| FormData | limit optional |
分页大小 | string | |
| FormData | offset optional |
offset | string | |
| FormData | order optional |
order | string | "ASC" |
| FormData | sort optional |
排序字段 | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResult«BpmInstance» |
Consumes
application/json
Produces
*/*
流程实例列表-当前组织
POST /bpm/instance/listJson_currentOrg |
描述
获取流程实例列表-当前组织，用于部门负责人管理本部门下的所有流程实例，可以查看任务情况、干预任务实例
请求入参
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| FormData | filter$VEQ optional |
其他过滤参数 | string | |
| FormData | limit optional |
分页大小 | string | |
| FormData | offset optional |
offset | string | |
| FormData | order optional |
order | string | "ASC" |
| FormData | sort optional |
排序字段 | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResult«BpmInstance» |
Consumes
application/json
Produces
*/*
流程实例禁用/启用
POST /bpm/instance/toForbidden |
描述
流程实例禁用启用接口
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | forbidden optional |
禁用/启用 | boolean |
| Query | id optional |
流程实例ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«string» |
Consumes
application/json
Produces
*/*
流程实例禁用/启用
GET /bpm/instance/toForbidden |
描述
流程实例禁用启用接口
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | forbidden optional |
禁用/启用 | boolean |
| Query | id optional |
流程实例ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«string» |
Consumes
application/json
Produces
*/*
用户信息服务接口
User Service Controller
获取用户信息
GET /org/userService/getUserByAccount/{account} |
描述
根据用户帐号获取用户对象
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | account required |
用户账户 | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«IUser» |
Consumes
application/json
Produces
*/*
获取用户信息
GET /org/userService/getUserById/{userId} |
描述
根据用户ID获取用户的对象
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | userId required |
用户ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«IUser» |
Consumes
application/json
Produces
*/*
获取组用户
POST /org/userService/getUserListByGroup |
描述
根据某组织下的用户
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | groupId required |
组ID | string |
| Query | groupType required |
组类型：org,post,role | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«List«IUser»» |
Consumes
application/json
Produces
*/*
获取组用户的角色
GET /org/userService/getUserRole/{userId} |
描述
根据用户ID 获取该用户的角色
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | userId required |
userId | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«List«IUserRole»» |
Consumes
application/json
Produces
*/*
用户组服务接口
Group Service Controller
通过用户账户，获取用户下的组织，结果以组类型为mapKey
GET /org/groupService/getAllGroupByAccount/{account} |
描述
根据用户账户，来获取相关的组，结果以组类型为mapKey
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | account required |
用户账户 | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«Map«string,List«IGroup»»» |
Consumes
application/json
Produces
*/*
获取用户下的组织，结果以组类型为mapKey
GET /org/groupService/getAllGroupByUserId/{userId} |
描述
根据用户id 获取用户当前所在的组，结果以组类型为mapKey
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | userId required |
用户ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«Map«string,List«IGroup»»» |
Consumes
application/json
Produces
*/*
根据组织CODE,获取组织详情信息
POST /org/groupService/getByCode |
描述
根据用户CODE,组织类型查找组织信息
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | code required |
组织code | string |
| Query | groupType required |
组织类型：GroupTypeConstant | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«IGroup» |
Consumes
application/json
Produces
*/*
根据组织ID,获取组织详情信息
POST /org/groupService/getById |
描述
根据用户id,组织类型查找组织信息
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | groupId required |
组织ID | string |
| Query | groupType required |
组织类型：GroupTypeConstant | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«IGroup» |
Consumes
application/json
Produces
*/*
获取用户下的某种组
POST /org/groupService/getGroupsByGroupTypeUserId |
描述
根据用户ID，组类别 来获取相关的组
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | groupType required |
组织类型：org,post,role | string |
| Query | userId required |
用户ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«List«IGroup»» |
Consumes
application/json
Produces
*/*
根据用户id，获取该用户所有组织列表
GET /org/groupService/getGroupsByUserId/{userId} |
描述
根据用户id 获取用户当前所在的组
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | userId required |
用户ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«List«IGroup»» |
Consumes
application/json
Produces
*/*
获取用户的主组织
GET /org/groupService/getMainGroup/{userId} |
描述
获取用户的主岗位、若未配置主岗位默认获取查询的第一个组织
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | userId required |
用户ID | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg«IGroup» |
Consumes
application/json
Produces
*/*
登陆服务接口
Login Controller
用户登录
POST /org/login/valid |
描述
登录鉴权
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| FormData | account optional |
账号 | string |
| FormData | password optional |
密码 | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg |
Consumes
application/json
Produces
*/*
用户登录
GET /org/login/valid |
描述
登录鉴权
请求入参
| Type | Name | Description | Schema |
|---|---|---|---|
| FormData | account optional |
账号 | string |
| FormData | password optional |
密码 | string |
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg |
Consumes
application/json
Produces
*/*
登陆用户信息服务接口
User Resource Controller
用户信息
POST /org/userResource/userMsg |
描述
获取用户信息，当前组织，可切换的组织岗位，当前系统，拥有的系统列表等信息
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg |
Consumes
application/json
Produces
*/*
用户信息
GET /org/userResource/userMsg |
描述
获取用户信息，当前组织，可切换的组织岗位，当前系统，拥有的系统列表等信息
返回结果
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResultMsg |
Consumes
application/json
Produces
*/*
Definitions
BpmDefinition
流程定义
| Name | Description | Schema |
|---|---|---|
| actDefId optional |
原生流程定义ID | string |
| actDeployId optional |
原生DeployId | string |
| actModelId optional |
原生流程设计MOdelID | string |
| createBy optional |
string | |
| createOrgId optional |
string | |
| createTime optional |
string (date-time) | |
| desc optional |
描述信息 | string |
| id optional |
流程定义ID | string |
| isMain optional |
是否主版本，Y/N | string |
| key optional |
流程定义KEY | string |
| name optional |
流程定义名字 | string |
| rev optional |
乐观锁版本判断 | integer (int32) |
| status optional |
流程状态 | string |
| supportMobile optional |
是否支持移动端 | integer (int32) |
| typeId optional |
流程分类 | string |
| updateBy optional |
string | |
| updateTime optional |
string (date-time) | |
| version optional |
版本号 | integer (int32) |
BpmForm
流程表单信息DTO
| Name | Description | Schema |
|---|---|---|
| formHandler optional |
Url 表单处理器 | string |
| formHtml optional |
Inner 表单HTML 内容 | string |
| formValue optional |
Inner表单Key，iframe的URL值 | string |
| name optional |
表单名称描述 | string |
| type optional |
表单类型 | enum (INNER, FRAME) |
BpmInstance
流程实例
| Name | Description | Schema |
|---|---|---|
| actDefId optional |
原生流程定义ID | string |
| actInstId optional |
原生实例ID | string |
| bizKey optional |
URL 表单业务主键 | string |
| createBy optional |
string | |
| createOrgId optional |
发起人当时的组织ID | string |
| createTime optional |
string (date-time) | |
| creator optional |
流程实例创建人，也是发起人 | string |
| defId optional |
流程定义ID | string |
| defKey optional |
流程定义KEY | string |
| defName optional |
流程定义名字 | string |
| duration optional |
流程持续时间 | integer (int64) |
| endTime optional |
流程终止时间 | string (date-time) |
| id optional |
流程实例ID | string |
| isForbidden optional |
是否被禁止 | integer (int32) |
| isFormmal optional |
是否正式数据，流程定义草稿状态发起的流程均为非正式数据 | string |
| parentInstId optional |
父实例ID | string |
| status optional |
流程实例状态 | string |
| subject optional |
流程标题 | string |
| superNodeId optional |
外部子流程父流程定义节点ID | string |
| supportMobile optional |
是否支持移动端 | integer (int32) |
| typeId optional |
所属分类 | string |
| updateBy optional |
string | |
| updateTime optional |
string (date-time) |
BpmTask
流程任务信息
| Name | Description | Schema |
|---|---|---|
| actExecutionId optional |
原生ExecutionId | string |
| actInstId optional |
原生实例ID | string |
| assigneeId optional |
候选人ID，若为0 则为多人 | string |
| assigneeNames optional |
候选人Name | string |
| backNode optional |
驳回后返回至节点 | string |
| createBy optional |
string | |
| createTime optional |
string (date-time) | |
| defId optional |
流程定义ID | string |
| dueTime optional |
string (date-time) | |
| id optional |
任务ID | string |
| instId optional |
流程实例ID | string |
| name optional |
任务名 | string |
| nodeId optional |
任务节点ID | string |
| parentId optional |
父任务ID 会签，分发等情况会用到 | string |
| priority optional |
任务优先级，默认50 | integer (int32) |
| status optional |
任务状态 | string |
| subject optional |
任务标题 | string |
| supportMobile optional |
任务是否支持移动端 | integer (int32) |
| taskId optional |
任务原生TaskID | string |
| taskType optional |
任务类型 | string |
| typeId optional |
string | |
| updateBy optional |
string | |
| updateTime optional |
string (date-time) |
BpmTaskApprove
| Name | Schema |
|---|---|
| actInstId optional |
string |
| approveStatus optional |
string |
| approveTime optional |
string (date-time) |
| createBy optional |
string |
| createTime optional |
string (date-time) |
| creator optional |
string |
| defName optional |
string |
| durMs optional |
integer (int64) |
| duration optional |
integer (int64) |
| endTime optional |
string (date-time) |
| id optional |
string |
| nodeId optional |
string |
| nodeName optional |
string |
| status optional |
string |
| subject optional |
string |
| typeId optional |
string |
BpmTaskOpinion
流程任务审批记录
| Name | Description | Schema |
|---|---|---|
| approveTime optional |
审批时间 | string (date-time) |
| approver optional |
任务审批人ID | string |
| approverName optional |
任务审批人名字 | string |
| assignInfo optional |
任务候选人情况 | string |
| createBy optional |
string | |
| createTime optional |
string (date-time) | |
| durMs optional |
任务处理耗时 | integer (int64) |
| id optional |
string | |
| instId optional |
流程实例ID | string |
| opinion optional |
任务处理意见 | string |
| status optional |
状态 | string |
| supInstId optional |
父实例ID，用于子流程 | string |
| taskId optional |
任务ID | string |
| taskKey optional |
任务节点ID | string |
| taskName optional |
任务名称 | string |
| updateBy optional |
string | |
| updateTime optional |
string (date-time) |
Button
流程节点按钮定义
| Name | Description | Schema |
|---|---|---|
| afterScript optional |
按钮提交后置js脚本 | string |
| alias optional |
按钮标识 | string |
| beforeScript optional |
按钮提交前置js脚本 | string |
| configPage optional |
按钮对应控制器后端处理器更多配置信息页 | string |
| groovyScript optional |
按钮后台权限 groovy脚本 | string |
| name optional |
按钮名字 | string |
FlowRequestParam
流程实例、流程任务 ActionCmd 请求参数，请参考FlowRequestParam.java 或者文档了解
| Name | Description | Schema |
|---|---|---|
| action optional |
action name 必须 | string |
| businessKey optional |
流程业务主键。 URL表单，可以直接赋值调用rest接口启动流程 | string |
| data optional |
流程业务数据，JSON格式：{boCodeA:{},boCodeB:{}} | < string, object > map |
| defId optional |
流程定义id，流程启动等场景必须 | string |
| destination optional |
目标节点 | string |
| extendConf optional |
特殊属性扩展配置：可以再 ActionCmd 中拿到此配置 | < string, object > map |
| formType optional |
表单类型 | string |
| instanceId optional |
流程实例id，流程草稿等场景 | string |
| nodeUsers optional |
前端节点人员设置 | < string, object > map |
| opinion optional |
流程任务审批意见 | string |
| taskId optional |
流程任务id，流程任务处理时必须 | string |
FormDefData
表单定义的页面数据类
| Name | Description | Schema |
|---|---|---|
| data optional |
表单的业务数据 JSON | < string, object > map |
| html optional |
表单的HTML 源码 | string |
| initData optional |
表单的初始化数据 | < string, object > map |
| permission optional |
表单字段的权限 | < string, object > map |
| tablePermission optional |
表单的表权限 | < string, object > map |
IBpmInstance
流程实例
| Name | Description | Schema |
|---|---|---|
| actDefId optional |
原生流程定义ID | string |
| actInstId optional |
原生实例ID | string |
| bizKey optional |
URL 表单业务主键 | string |
| createBy optional |
string | |
| createOrgId optional |
发起人当时的组织ID | string |
| createTime optional |
string (date-time) | |
| creator optional |
流程实例创建人，也是发起人 | string |
| defId optional |
流程定义ID | string |
| defKey optional |
流程定义KEY | string |
| defName optional |
流程定义名字 | string |
| duration optional |
流程持续时间 | integer (int64) |
| endTime optional |
流程终止时间 | string (date-time) |
| id optional |
流程实例ID | string |
| isForbidden optional |
是否被禁止 | integer (int32) |
| isFormmal optional |
是否正式数据，流程定义草稿状态发起的流程均为非正式数据 | string |
| parentInstId optional |
父实例ID | string |
| status optional |
流程实例状态 | string |
| subject optional |
流程标题 | string |
| superNodeId optional |
外部子流程父流程定义节点ID | string |
| supportMobile optional |
是否支持移动端 | integer (int32) |
| typeId optional |
所属分类 | string |
| updateBy optional |
string | |
| updateTime optional |
string (date-time) |
IGroup
组定义，含org,role,post 组类型详见 GroupTypeConstant.java
| Name | Description | Schema |
|---|---|---|
| groupCode optional |
组CODE | string |
| groupId optional |
组ID | string |
| groupName optional |
组名字 | string |
| groupType optional |
组类型：org,role,post | string |
| parentId optional |
树形组 parentId | string |
IUser
用户信息
| Name | Description | Schema |
|---|---|---|
| account optional |
账户 | string |
| email optional |
string | |
| fullname optional |
用户名 | string |
| mobile optional |
手机号 | string |
| password optional |
密码 | string |
| status optional |
是否启用 0/1 | integer (int32) |
| userId optional |
用户ID | string |
| weixin optional |
微信号 | string |
IUserRole
用户角色新
| Name | Description | Schema |
|---|---|---|
| account optional |
用户账户 | string |
| alias optional |
角色标识 | string |
| fullname optional |
用户名 | string |
| roleId optional |
角色ID | string |
| roleName optional |
角色名 | string |
| userId optional |
用户ID | string |
Map«string,List«IGroup»»
Type : < string, List > map
PageResult
通用分页结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
| page optional |
当前页 | integer (int32) |
| pageSize optional |
分页大小 | integer (int32) |
| rows optional |
分页列表数据 | < object > array |
| total optional |
总条数 | integer (int32) |
PageResult«BpmDefinition»
通用分页结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
| page optional |
当前页 | integer (int32) |
| pageSize optional |
分页大小 | integer (int32) |
| rows optional |
分页列表数据 | < BpmDefinition > array |
| total optional |
总条数 | integer (int32) |
PageResult«BpmInstance»
通用分页结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
| page optional |
当前页 | integer (int32) |
| pageSize optional |
分页大小 | integer (int32) |
| rows optional |
分页列表数据 | < BpmInstance > array |
| total optional |
总条数 | integer (int32) |
PageResult«BpmTaskApprove»
通用分页结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
| page optional |
当前页 | integer (int32) |
| pageSize optional |
分页大小 | integer (int32) |
| rows optional |
分页列表数据 | < BpmTaskApprove > array |
| total optional |
总条数 | integer (int32) |
PageResult«BpmTask»
通用分页结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
| page optional |
当前页 | integer (int32) |
| pageSize optional |
分页大小 | integer (int32) |
| rows optional |
分页列表数据 | < BpmTask > array |
| total optional |
总条数 | integer (int32) |
ResultMsg
标准的返回结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| data optional |
结果数据 | object |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
ResultMsg«BpmTask»
标准的返回结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| data optional |
结果数据 | BpmTask |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
ResultMsg«FormDefData»
标准的返回结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| data optional |
结果数据 | FormDefData |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
ResultMsg«IBpmInstance»
标准的返回结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| data optional |
结果数据 | IBpmInstance |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
ResultMsg«IGroup»
标准的返回结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| data optional |
结果数据 | IGroup |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
ResultMsg«IUser»
标准的返回结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| data optional |
结果数据 | IUser |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
ResultMsg«List«BpmTaskOpinion»»
标准的返回结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| data optional |
结果数据 | < BpmTaskOpinion > array |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
ResultMsg«List«IGroup»»
标准的返回结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| data optional |
结果数据 | < IGroup > array |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
ResultMsg«List«IUserRole»»
标准的返回结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| data optional |
结果数据 | < IUserRole > array |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
ResultMsg«List«IUser»»
标准的返回结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| data optional |
结果数据 | < IUser > array |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
ResultMsg«Map«string,List«IGroup»»»
标准的返回结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| data optional |
结果数据 | < string, < IGroup > array > map |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
ResultMsg«Map«string,object»»
标准的返回结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| data optional |
结果数据 | object |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
ResultMsg«string»
标准的返回结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| data optional |
结果数据 | string |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
ResultMsg«FlowData»
标准的返回结果包装类
| Name | Description | Schema |
|---|---|---|
| cause optional |
异常堆栈信息 | string |
| code optional |
状态码 | string |
| data optional |
结果数据 | FlowData |
| isOk optional |
本次调用是否成功 Example : false |
boolean |
| msg optional |
操作提示信息 | string |
FlowData
| Name | Description | Schema |
|---|---|---|
| buttonList optional |
流程 当前节点按钮信息 | < Button > array |
| data optional |
流程自定义表单业务数据 | < string, object > map |
| defId optional |
流程定义ID | string |
| form optional |
流程当前节点表单 | BpmForm |
| initData optional |
流程自定义表单 初始化数据，可用于子表数据复制赋值 | < string, object > map |
| permission optional |
流程自定义表单 字段权限 | < string, object > map |
| tablePermission optional |
流程自定义表单 表权限 | < string, object > map |