流程中心

ProcessDefinitionRestApi

com.magus.cloud.camunda.client.api.ProcessDefinitionRestApi

findByProcDefId

接口说明

预览流程图

请求地址

GET /magus-camunda/process/definition/preview/{procDefId}

请求参数

参数名	父级	类型	是否必须	示例值	描述
procDefId		String	1		流程定义id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
id	data	String	id
procDefId	data	String	流程定义id
procDefKey	data	String	流程定义key
pageUri	data	String	页面uri
pageFlag	data	Boolean	内外部表单
models	data	String	流程xml
nodes	data	Array	节点信息
nodeKey	nodes	String	流程节点key
pageUri	nodes	String	页面url
pageFlag	nodes	Boolean	内部表单/外部表单
fieldsPermission	nodes	Array	字段权限
pageUri	fieldsPermission	String	页面uri
procDefId	fieldsPermission	String	流程定义id
nodeKey	fieldsPermission	String	节点key
componentId	fieldsPermission	String	组件id
permission	fieldsPermission	String	权限

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
    "id": "",
    "procDefId": "",
    "procDefKey": "",
    "pageFlag": false,
    "pageUri": "",
    "models": "",
    "nodes": [
      {
        "nodeKey": "",
        "pageFlag": false,
        "pageUri": "",
        "fieldsPermission": [
          {
            "pageUri": "",
            "procDefId": "",
            "nodeKey": "",
            "componentId": "",
            "permission": ""
          }
        ]
      }
    ]
  }
}

findByProcDefId

接口说明

流程定义详情

请求地址

GET /magus-camunda/process/definition/find-by-procDefId/{procDefId}

请求参数

参数名	父级	类型	是否必须	示例值	描述
procDefId		String	1		流程定义id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
id	data	String	id
procDefId	data	String	流程定义id
procDefName	data	String	流程定义名
procDefKey	data	String	流程定义key
version	data	Integer	流程定义版本
state	data	String	状态
withdrawFlag	data	Boolean	流程发起后允许撤回（是否启用,0=未启用;1=已启用）
commentFlag	data	Boolean	流程发起后允许评论（是否启用,0=未启用;1=已启用）
viewFlag	data	Boolean	允许查看流程动态和流程图（是否启用,0=未启用;1=已启用）
completeRule	data	String	自动同意规则(CLOSE:不启用；START_USER：审批人为发起人；NEIGHBOR：审批人与上一节点处理人相同；PARTICIPATION：审批人处理过该流程(默认选择不启用)
rejectRule	data	String	驳回规则(FROM_START_NODE:从头开始审批；FROM_REJECT_NODE：从驳回节点审批(默认选择从头开始审批)
pageFlag	data	Boolean	是否是内部表单：默认true
pageUri	data	String	页面uri
companyId	data	String	归属公司

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
    "procDefId": "",
    "procDefName": "",
    "procDefKey": "",
    "version": 0,
    "state": false,
    "withdrawFlag": false,
    "commentFlag": false,
    "viewFlag": false,
    "completeRule": "",
    "rejectRule": "",
    "pageFlag": false,
    "pageUri": "",
    "companyId": ""
  }
}

findUpProcessByProcDefKey

接口说明

流程key下启用的流程

请求地址

GET /magus-camunda/process/definition/find-by-procDefKey/{procDefKey}

请求参数

参数名	父级	类型	是否必须	示例值	描述
procDefKey		String	1		流程定义key

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
id	data	String	id
procDefId	data	String	流程定义id
procDefName	data	String	流程定义名
procDefKey	data	String	流程定义key
version	data	Integer	流程定义版本
state	data	String	状态
withdrawFlag	data	Boolean	流程发起后允许撤回（是否启用,0=未启用;1=已启用）
commentFlag	data	Boolean	流程发起后允许评论（是否启用,0=未启用;1=已启用）
viewFlag	data	Boolean	允许查看流程动态和流程图（是否启用,0=未启用;1=已启用）
completeRule	data	String	自动同意规则(CLOSE:不启用；START_USER：审批人为发起人；NEIGHBOR：审批人与上一节点处理人相同；PARTICIPATION：审批人处理过该流程(默认选择不启用)
rejectRule	data	String	驳回规则(FROM_START_NODE:从头开始审批；FROM_REJECT_NODE：从驳回节点审批(默认选择从头开始审批)
pageFlag	data	Boolean	是否是内部表单：默认true
pageUri	data	String	页面uri
companyId	data	String	归属公司

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
    "procDefId": "",
    "procDefName": "",
    "procDefKey": "",
    "version": 0,
    "state": false,
    "withdrawFlag": false,
    "commentFlag": false,
    "viewFlag": false,
    "completeRule": "",
    "rejectRule": "",
    "pageFlag": false,
    "pageUri": "",
    "companyId": ""
  }
}

listByProcDefKey

接口说明

流程key下所有的流程定义

请求地址

GET /magus-camunda/process/definition/list-by-procDefKey/{procDefKey}

请求参数

参数名	父级	类型	是否必须	示例值	描述
procDefKey		String	1		流程定义key

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	list	String	id
procDefId	list	String	流程定义id
procDefName	list	String	流程定义名
procDefKey	list	String	流程定义key
version	list	Integer	流程定义版本
state	list	String	状态
withdrawFlag	list	Boolean	流程发起后允许撤回（是否启用,0=未启用;1=已启用）
commentFlag	list	Boolean	流程发起后允许评论（是否启用,0=未启用;1=已启用）
viewFlag	list	Boolean	允许查看流程动态和流程图（是否启用,0=未启用;1=已启用）
completeRule	list	String	自动同意规则(CLOSE:不启用；START_USER：审批人为发起人；NEIGHBOR：审批人与上一节点处理人相同；PARTICIPATION：审批人处理过该流程(默认选择不启用)
rejectRule	list	String	驳回规则(FROM_START_NODE:从头开始审批；FROM_REJECT_NODE：从驳回节点审批(默认选择从头开始审批)
pageFlag	list	Boolean	是否是内部表单：默认true
pageUri	list	String	页面uri
companyId	list	String	归属公司

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "procDefId": "",
      "procDefName": "",
      "procDefKey": "",
      "version": 0,
      "state": false,
      "withdrawFlag": false,
      "commentFlag": false,
      "viewFlag": false,
      "completeRule": "",
      "rejectRule": "",
      "pageFlag": false,
      "pageUri": "",
      "companyId": ""
    }
  ]
}

pageKey

接口说明

流程key分页

请求地址

POST /magus-camunda/process/instance/page/key

请求参数

参数名	父级	类型	是否必须	示例值	描述
req		Object	1
procDefName	req	String	0		流程定义名称
procDefKey	req	String	0		流程定义key
page	req	int	1	1	当前页码
size	req	int	1	10	每页条数
attr	req	String	0	createDate	排序的字段名
sort	req	String	0	DESC	ASC; DESC

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
totalNum		Long	总条数
totalPage		Long	总页数
page		Int	当前页数
size		Int	每页条数
list		Array
id	list	String	id
procDefId	list	String	流程定义id
procDefName	list	String	流程定义名
procDefKey	list	String	流程定义key
version	list	Integer	流程定义版本
state	list	String	状态
withdrawFlag	list	Boolean	流程发起后允许撤回（是否启用,0=未启用;1=已启用）
commentFlag	list	Boolean	流程发起后允许评论（是否启用,0=未启用;1=已启用）
viewFlag	list	Boolean	允许查看流程动态和流程图（是否启用,0=未启用;1=已启用）
completeRule	list	String	自动同意规则(CLOSE:不启用；START_USER：审批人为发起人；NEIGHBOR：审批人与上一节点处理人相同；PARTICIPATION：审批人处理过该流程(默认选择不启用)
rejectRule	list	String	驳回规则(FROM_START_NODE:从头开始审批；FROM_REJECT_NODE：从驳回节点审批(默认选择从头开始审批)
pageFlag	list	Boolean	是否是内部表单：默认true
pageUri	list	String	页面uri
companyId	list	String	归属公司

请求示例

{
  "procDefId": "",
  "procDefName": "",
  "procDefKey": "",
  "type": "",
  "industryCategory": "",
  "sceneCategory": "",
  "page": 0,
  "size": 0,
  "attr": "",
  "sort": ""
}

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "totalNum": 0,
  "totalPage": 0,
  "page": 0,
  "size": 0,
  "list": [
    {
      "procDefId": "",
      "procDefName": "",
      "procDefKey": "",
      "version": 0,
      "state": false,
      "withdrawFlag": false,
      "commentFlag": false,
      "viewFlag": false,
      "completeRule": "",
      "rejectRule": "",
      "pageFlag": false,
      "pageUri": "",
      "companyId": ""
    }
  ]
}

pageId

接口说明

流程id分页

请求地址

POST /magus-camunda/process/instance/page/id

请求参数

参数名	父级	类型	是否必须	示例值	描述
req		Object	1
procDefId	req	String	0	Process_153teed:12:bd454540-55e1-11ee-a704-0ad6eb5ab38b	流程定义id
procDefName	req	String	0	Process_153teed	流程定义名称
procDefKey	req	String	1	项目审批流程	流程定义key
page	req	int	1	1	当前页码
size	req	int	1	10	每页条数
attr	req	String	0	createDate	排序的字段名
sort	req	String	0	DESC	ASC; DESC

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
totalNum		Long	总条数
totalPage		Long	总页数
page		Int	当前页数
size		Int	每页条数
list		Array
id	list	String	id
procDefId	list	String	流程定义id
procDefName	list	String	流程定义名
procDefKey	list	String	流程定义key
version	list	Integer	流程定义版本
state	list	String	状态
withdrawFlag	list	Boolean	流程发起后允许撤回（是否启用,0=未启用;1=已启用）
commentFlag	list	Boolean	流程发起后允许评论（是否启用,0=未启用;1=已启用）
viewFlag	list	Boolean	允许查看流程动态和流程图（是否启用,0=未启用;1=已启用）
completeRule	list	String	自动同意规则(CLOSE:不启用；START_USER：审批人为发起人；NEIGHBOR：审批人与上一节点处理人相同；PARTICIPATION：审批人处理过该流程(默认选择不启用)
rejectRule	list	String	驳回规则(FROM_START_NODE:从头开始审批；FROM_REJECT_NODE：从驳回节点审批(默认选择从头开始审批)
pageFlag	list	Boolean	是否是内部表单：默认true
pageUri	list	String	页面uri
companyId	list	String	归属公司

请求示例

{
  "procDefId": "",
  "procDefName": "",
  "procDefKey": "",
  "type": "",
  "industryCategory": "",
  "sceneCategory": "",
  "page": 0,
  "size": 0,
  "attr": "",
  "sort": ""
}

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "totalNum": 0,
  "totalPage": 0,
  "page": 0,
  "size": 0,
  "list": [
    {
      "procDefId": "",
      "procDefName": "",
      "procDefKey": "",
      "version": 0,
      "state": false,
      "withdrawFlag": false,
      "commentFlag": false,
      "viewFlag": false,
      "completeRule": "",
      "rejectRule": "",
      "pageFlag": false,
      "pageUri": "",
      "companyId": ""
    }
  ]
}

pagePublishProcess

接口说明

已发布的流程分页

请求地址

POST /magus-camunda/process/instance/page/publish-process

请求参数

参数名	父级	类型	是否必须	示例值	描述
req		Object	1
procDefName	req	String	0		流程定义名称
procDefKey	req	String	0		流程定义key
page	req	int	1	1	当前页码
size	req	int	1	10	每页条数
attr	req	String	0	createDate	排序的字段名
sort	req	String	0	DESC	ASC; DESC

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
totalNum		Long	总条数
totalPage		Long	总页数
page		Int	当前页数
size		Int	每页条数
list		Array
id	list	String	id
procDefId	list	String	流程定义id
procDefName	list	String	流程定义名
procDefKey	list	String	流程定义key
version	list	Integer	流程定义版本
state	list	String	状态
withdrawFlag	list	Boolean	流程发起后允许撤回（是否启用,0=未启用;1=已启用）
commentFlag	list	Boolean	流程发起后允许评论（是否启用,0=未启用;1=已启用）
viewFlag	list	Boolean	允许查看流程动态和流程图（是否启用,0=未启用;1=已启用）
completeRule	list	String	自动同意规则(CLOSE:不启用；START_USER：审批人为发起人；NEIGHBOR：审批人与上一节点处理人相同；PARTICIPATION：审批人处理过该流程(默认选择不启用)
rejectRule	list	String	驳回规则(FROM_START_NODE:从头开始审批；FROM_REJECT_NODE：从驳回节点审批(默认选择从头开始审批)
pageFlag	list	Boolean	是否是内部表单：默认true
pageUri	list	String	页面uri
companyId	list	String	归属公司

请求示例

{
  "procDefId": "",
  "procDefName": "",
  "procDefKey": "",
  "type": "",
  "industryCategory": "",
  "sceneCategory": "",
  "page": 0,
  "size": 0,
  "attr": "",
  "sort": ""
}

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "totalNum": 0,
  "totalPage": 0,
  "page": 0,
  "size": 0,
  "list": [
    {
      "procDefId": "",
      "procDefName": "",
      "procDefKey": "",
      "version": 0,
      "state": false,
      "withdrawFlag": false,
      "commentFlag": false,
      "viewFlag": false,
      "completeRule": "",
      "rejectRule": "",
      "pageFlag": false,
      "pageUri": "",
      "companyId": ""
    }
  ]
}

onOrOff

接口说明

关停/启用

请求地址

POST /magus-camunda/process/instance/on-off/{processDefinitionId}

请求参数

参数名	父级	类型	是否必须	示例值	描述
processDefinitionId		String	1		流程定义id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
totalNum		Long	总条数
totalPage		Long	总页数
page		Int	当前页数
size		Int	每页条数

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "totalNum": 0,
  "totalPage": 0,
  "page": 0,
  "size": 0
}

test

接口说明

流程测试

请求地址

POST /magus-camunda/process/instance/test/{processDefinitionId}

请求参数

参数名	父级	类型	是否必须	示例值	描述
processDefinitionId		String	1		流程定义id
variables		Object			变量

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
totalNum		Long	总条数
totalPage		Long	总页数
page		Int	当前页数
size		Int	每页条数

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "totalNum": 0,
  "totalPage": 0,
  "page": 0,
  "size": 0
}

upload

接口说明

流程上传

请求地址

POST /magus-camunda/process/instance/upload

请求参数

参数名	父级	类型	是否必须	示例值	描述
file		MultipartFile	1		流程文件

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
totalNum		Long	总条数
totalPage		Long	总页数
page		Int	当前页数
size		Int	每页条数

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "totalNum": 0,
  "totalPage": 0,
  "page": 0,
  "size": 0
}

deleteByProcDefIdIn

接口说明

删除流程定义

请求地址

POST /magus-camunda/process/instance/delete-in-procDefId

请求参数

参数名	父级	类型	是否必须	示例值	描述
processDefinitionId		String	1		流程定义id
variables		Object			变量

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
totalNum		Long	总条数
totalPage		Long	总页数
page		Int	当前页数
size		Int	每页条数

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "totalNum": 0,
  "totalPage": 0,
  "page": 0,
  "size": 0
}

ProcessInstanceRestApi

com.magus.cloud.camunda.client.api.ProcessInstanceRestApi

count

接口说明

流程统计

请求地址

GET /magus-camunda/process/instance/count

请求参数

参数名	父级	类型	是否必须	示例值	描述

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Array
todo	data	Integer	待我处理的数量
done	data	Integer	我已处理的数量
cc	data	Integer	抄送我的数量
sent	data	Integer	已发事项的数量
ready	data	Integer	待发事项的数量

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
    "todo": 0,
    "done": 0,
    "cc": 0,
    "sent": 0,
    "ready": 0
  }
}

page

接口说明

流程分页

请求地址

POST /magus-camunda/process/instance/page

请求参数

参数名	父级	类型	是否必须	示例值	描述
req		Object	1
beginTime	req	Date	0		开始时间
endTime	req	Date	0		结束时间
keyword	req	String	0		关键字
source	req	String	1		搜索来源分类
page	req	int	1	1	当前页码
size	req	int	1	10	每页条数
attr	req	String	0	createDate	排序的字段名
sort	req	String	0	DESC	ASC; DESC

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
totalNum		Long	总条数
totalPage		Long	总页数
page		Int	当前页数
size		Int	每页条数
list		Array
id	list	String	id
processNo	list	String	流程编号
title	list	String	流程实例标题
procDefId	list	String	流程定义id
procInstId	list	String	流程实例id
pageId	list	String	页面标识编码
pageUri	list	String	页面标识uri
rejectNodeKey	list	String	被驳回的节点
startUserId	list	String	发起人id
startUserName	list	String	发起人
status	list	String	状态
businessTableName	list	String	业务表名称
businessId	list	String	业务数据ID
startTime	list	Date	发起时间

请求示例

{
  "beginTime": 0,
  "endTime": 0,
  "keyword": "",
  "source": "",
  "page": 0,
  "size": 0,
  "attr": "",
  "sort": ""
}

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "totalNum": 0,
  "totalPage": 0,
  "page": 0,
  "size": 0,
  "list": [
    {
      "id": "",
      "processNo": "",
      "title": "",
      "procDefId": "",
      "procInstId": "",
      "pageId": "",
      "pageUri": "",
      "rejectNodeKey": "",
      "startUserId": "",
      "startUserName": "",
      "status": "",
      "businessTableName": "",
      "businessId": "",
      "startTime": "2023-11-22 09:08:03"
    }
  ]
}

findByid

接口说明

流程详情

请求地址

GET /magus-camunda/process/definition/find-by-id/{id}

请求参数

参数名	父级	类型	是否必须	示例值	描述
procDefKey		String	1		流程定义key

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
id	data	String	id
processNo	data	String	流程编号
title	data	String	流程实例标题
procDefId	data	String	流程定义id
procInstId	data	String	流程实例id
pageId	data	String	页面标识编码
pageUri	data	String	页面标识uri
rejectNodeKey	data	String	被驳回的节点
startUserId	data	String	发起人id
startUserName	data	String	发起人
status	data	String	状态
businessTableName	data	String	业务表名称
businessId	data	String	业务数据ID
startTime	data	Date	发起时间

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
    "procDefId": "",
    "procDefName": "",
    "procDefKey": "",
    "version": 0,
    "state": false,
    "withdrawFlag": false,
    "commentFlag": false,
    "viewFlag": false,
    "completeRule": "",
    "rejectRule": "",
    "pageFlag": false,
    "pageUri": "",
    "companyId": ""
  }
}

findRunningByProcDefKey

接口说明

查询流程key下启用的流程正在运行的流程实例

请求地址

GET /magus-camunda/process/instance/running/find-by-procDefKey/{procDefKey}

请求参数

参数名	父级	类型	是否必须	示例值	描述
procDefKey		String	1		流程定义key

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	list	String	id
processNo	list	String	流程编号
title	list	String	流程实例标题
procDefId	list	String	流程定义id
procInstId	list	String	流程实例id
pageId	list	String	页面标识编码
pageUri	list	String	页面标识uri
rejectNodeKey	list	String	被驳回的节点
startUserId	list	String	发起人id
startUserName	list	String	发起人
status	list	String	状态
businessTableName	list	String	业务表名称
businessId	list	String	业务数据ID
startTime	list	Date	发起时间

请求示例

{
  "beginTime": 0,
  "endTime": 0,
  "keyword": "",
  "source": "",
  "page": 0,
  "size": 0,
  "attr": "",
  "sort": ""
}

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "id": "",
      "processNo": "",
      "title": "",
      "procDefId": "",
      "procInstId": "",
      "pageId": "",
      "pageUri": "",
      "rejectNodeKey": "",
      "startUserId": "",
      "startUserName": "",
      "status": "",
      "businessTableName": "",
      "businessId": "",
      "startTime": "2023-11-22 09:08:03"
    }
  ]
}

findByBusinessId

接口说明

根据 businessId 查询流程实例(只适用于web版)

请求地址

GET /magus-camunda/process/definition/find-by-businessId

请求参数

参数名	父级	类型	是否必须	示例值	描述
businessId		String	1		业务数据id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
data		Object
id	data	String	id
processNo	data	String	流程编号
title	data	String	流程实例标题
procDefId	data	String	流程定义id
procInstId	data	String	流程实例id
pageId	data	String	页面标识编码
pageUri	data	String	页面标识uri
rejectNodeKey	data	String	被驳回的节点
startUserId	data	String	发起人id
startUserName	data	String	发起人
status	data	String	状态
businessTableName	data	String	业务表名称
businessId	data	String	业务数据ID
startTime	data	Date	发起时间

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "data": {
    "procDefId": "",
    "procDefName": "",
    "procDefKey": "",
    "version": 0,
    "state": false,
    "withdrawFlag": false,
    "commentFlag": false,
    "viewFlag": false,
    "completeRule": "",
    "rejectRule": "",
    "pageFlag": false,
    "pageUri": "",
    "companyId": ""
  }
}

listInBusinessId

接口说明

根据 businessId 批量查询流程实例(只适用于web版)

请求地址

POST /magus-camunda/process/instance/list-in-businessId

请求参数

参数名	父级	类型	是否必须	示例值	描述
businessIds		Array	1		业务数据id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	list	String	id
processNo	list	String	流程编号
title	list	String	流程实例标题
procDefId	list	String	流程定义id
procInstId	list	String	流程实例id
pageId	list	String	页面标识编码
pageUri	list	String	页面标识uri
rejectNodeKey	list	String	被驳回的节点
startUserId	list	String	发起人id
startUserName	list	String	发起人
status	list	String	状态
businessTableName	list	String	业务表名称
businessId	list	String	业务数据ID
startTime	list	Date	发起时间

请求示例

{
  "beginTime": 0,
  "endTime": 0,
  "keyword": "",
  "source": "",
  "page": 0,
  "size": 0,
  "attr": "",
  "sort": ""
}

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "id": "",
      "processNo": "",
      "title": "",
      "procDefId": "",
      "procInstId": "",
      "pageId": "",
      "pageUri": "",
      "rejectNodeKey": "",
      "startUserId": "",
      "startUserName": "",
      "status": "",
      "businessTableName": "",
      "businessId": "",
      "startTime": "2023-11-22 09:08:03"
    }
  ]
}

draft

接口说明

流程申请保存草稿

请求地址

POST /magus-camunda/process/instance/draft

请求参数

参数名	父级	类型	是否必须	示例值	描述
req		Object
id	req	String	0	2907da64-5b47-11ee-913a-a684fe3d13d0	id
procDefId	req	String	0	Process_0n2qtqt:10:516dde5a-6730-11ee-8240-3a234b873142	流程定义id
appendixIds	req	Array	0	["2907da64-5b47-11ee-913a-a684fe3d13d1"]	附件id
existFlag	req	Boolean	0	TRUE	是否存在操作（true：编辑操作；false:保存操作）
businessTableName	req	String	0	expense	业务数据模型名称(草稿状态)
businessDataId	req	String	0	2907da64-5b47-11ee-913a-a684fe3d13d0	业务数据模型名称(草稿状态)
pageId	req	String	0	5c44ae34-7a63-4279-af07-11a772ff8904	页面标识编码
pageUri	req	String	0	/generator/low-code-app/b658772b-f505-4f7c-92a3-c140cc2adc19	页面标识uri
data	req	Array	0		业务数据
tableKey	data	String	0		表名
tableData	data	Object	0		业务数据
subForms	data	Array	0		子表
authData	data	Array	0		权限
code	authData	String	0		资源类型code
data	authData	Object	0		资源数据
code	data	String	0		资源code
name	data	String	0		资源名称

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean

请求示例

{
  "id": "",
  "procDefId": "",
  "appendixIds": [
    ""
  ],
  "existFlag": false,
  "data": [
    {
      "tableKey": "",
      "tableData": [
        {}
      ],
      "authData": [
        {
          "code": "",
          "data": [
            {
              "code": "",
              "name": ""
            }
          ]
        }
      ],
      "subForms": []
    }
  ],
  "businessTableName": "",
  "businessDataId": "",
  "pageId": "",
  "pageUri": ""
}

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true
}

submit

接口说明

流程申请提交

请求地址

POST /magus-camunda/process/instance/submit

请求参数

参数名	父级	类型	是否必须	示例值	描述
req		Object
id	req	String	0	2907da64-5b47-11ee-913a-a684fe3d13d0	id
procDefId	req	String	0	Process_0n2qtqt:10:516dde5a-6730-11ee-8240-3a234b873142	流程定义id
appendixIds	req	Array	0	["2907da64-5b47-11ee-913a-a684fe3d13d1"]	附件id
existFlag	req	Boolean	0	TRUE	是否存在操作（true：编辑操作；false:保存操作）
businessTableName	req	String	0	expense	业务数据模型名称(草稿状态)
businessDataId	req	String	0	2907da64-5b47-11ee-913a-a684fe3d13d0	业务数据模型名称(草稿状态)
pageId	req	String	0	5c44ae34-7a63-4279-af07-11a772ff8904	页面标识编码
pageUri	req	String	0	/generator/low-code-app/b658772b-f505-4f7c-92a3-c140cc2adc19	页面标识uri
data	req	Array	0		业务数据
tableKey	data	String	0		表名
tableData	data	Object	0		业务数据
subForms	data	Array	0		子表
authData	data	Array	0		权限
code	authData	String	0		资源类型code
data	authData	Object	0		资源数据
code	data	String	0		资源code
name	data	String	0		资源名称

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean

请求示例

{
  "id": "",
  "procDefId": "",
  "appendixIds": [
    ""
  ],
  "existFlag": false,
  "data": [
    {
      "tableKey": "",
      "tableData": [
        {}
      ],
      "authData": [
        {
          "code": "",
          "data": [
            {
              "code": "",
              "name": ""
            }
          ]
        }
      ],
      "subForms": []
    }
  ],
  "businessTableName": "",
  "businessDataId": "",
  "pageId": "",
  "pageUri": ""
}

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true
}

submit

接口说明

流程申请提交

请求地址

POST /magus-camunda/process/instance/submit/{id}

请求参数

参数名	父级	类型	是否必须	示例值	描述
id		String	1	2907da64-5b47-11ee-913a-a684fe3d13d0	id
variables		Object	0		变量

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true
}

update

接口说明

流程实例草稿编辑

请求地址

POST /magus-camunda/process/instance/update

请求参数

参数名	父级	类型	是否必须	示例值	描述
req		Object
id	req	String	0	2907da64-5b47-11ee-913a-a684fe3d13d0	id
procDefId	req	String	0	Process_0n2qtqt:10:516dde5a-6730-11ee-8240-3a234b873142	流程定义id
appendixIds	req	Array	0	["2907da64-5b47-11ee-913a-a684fe3d13d1"]	附件id
existFlag	req	Boolean	0	TRUE	是否存在操作（true：编辑操作；false:保存操作）
businessTableName	req	String	0	expense	业务数据模型名称(草稿状态)
businessDataId	req	String	0	2907da64-5b47-11ee-913a-a684fe3d13d0	业务数据模型名称(草稿状态)
pageId	req	String	0	5c44ae34-7a63-4279-af07-11a772ff8904	页面标识编码
pageUri	req	String	0	/generator/low-code-app/b658772b-f505-4f7c-92a3-c140cc2adc19	页面标识uri
data	req	Array	0		业务数据
tableKey	data	String	0		表名
tableData	data	Object	0		业务数据
subForms	data	Array	0		子表
authData	data	Array	0		权限
code	authData	String	0		资源类型code
data	authData	Object	0		资源数据
code	data	String	0		资源code
name	data	String	0		资源名称

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean

请求示例

{
  "id": "",
  "procDefId": "",
  "appendixIds": [
    ""
  ],
  "existFlag": false,
  "data": [
    {
      "tableKey": "",
      "tableData": [
        {}
      ],
      "authData": [
        {
          "code": "",
          "data": [
            {
              "code": "",
              "name": ""
            }
          ]
        }
      ],
      "subForms": []
    }
  ],
  "businessTableName": "",
  "businessDataId": "",
  "pageId": "",
  "pageUri": ""
}

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true
}

deleteByBusinessIdIn

接口说明

批量删除业务数据对应流程(只适用于web版)

请求地址

POST /magus-camunda/process/instance/delete-in-businessId

请求参数

参数名	父级	类型	是否必须	示例值	描述
businessIds		Array	1	["2907da64-5b47-11ee-913a-a684fe3d13d0"]	id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true
}

delete

接口说明

流程申请提交

请求地址

POST /magus-camunda/process/instance/delete/{id}

请求参数

参数名	父级	类型	是否必须	示例值	描述
id		String	1	2907da64-5b47-11ee-913a-a684fe3d13d0	id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	调用结果
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true
}

ProcessNodeRestApi

com.magus.cloud.camunda.client.api.ProcessNodeRestApi

listByProcDefId

接口说明

查询流程定义下的用户节点

请求地址

GET /magus-camunda/process/node/list-by-procDefId/{procDefId}

请求参数

参数名	父级	类型	是否必须	示例值	描述
procDefId		String	1		流程定义id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	list	String	id
nodeKey	list	String	节点定义key
nodeName	list	String	节点定义名称
nodeType	list	String	节点类型
procDefId	list	String	流程定义ID
procDefName	list	String	流程定义名称
assignee	list	String	task处理人
candidateUsers	list	String	task候选人参数
candidateGroups	list	String	task候选人组参数
applicant	list	Boolean	是否是申请人节点
ccFlag	list	Boolean	是否启用抄送
opinionFlag	list	Boolean	是否启用意见输入框
signatureFlag	list	Boolean	是否启用手写签名
pageFlag	list	Boolean	是否是内部表单：默认true
pageUri	list	String	页面uri

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "id": "",
      "nodeKey": "",
      "nodeName": "",
      "nodeType": "",
      "procDefId": "",
      "procDefName": "",
      "assignee": "",
      "candidateUsers": "",
      "candidateGroups": "",
      "applicant": false,
      "ccFlag": false,
      "opinionFlag": false,
      "signatureFlag": false,
      "pageFlag": false,
      "pageUri": ""
    }
  ]
}

ProcessTaskRestApi

com.magus.cloud.camunda.client.api.ProcessTaskRestApi

listByTaskId

接口说明

查询当前流程实例运行中的节点

请求地址

GET /magus-camunda/process/task/running/find-by-procInstId/{procInstId}

请求参数

参数名	父级	类型	是否必须	示例值	描述
procInstId		String	1		流程实例id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	list	String	id
nodeKey	list	String	节点定义key
nodeName	list	String	节点定义名称
nodeType	list	String	节点类型
procDefId	list	String	流程定义ID
procDefName	list	String	流程定义名称
assignee	list	String	task处理人
candidateUsers	list	String	task候选人参数
candidateGroups	list	String	task候选人组参数
applicant	list	Boolean	是否是申请人节点
ccFlag	list	Boolean	是否启用抄送
opinionFlag	list	Boolean	是否启用意见输入框
signatureFlag	list	Boolean	是否启用手写签名
pageFlag	list	Boolean	是否是内部表单：默认true
pageUri	list	String	页面uri

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "id": "",
      "nodeKey": "",
      "nodeName": "",
      "nodeType": "",
      "procDefId": "",
      "procDefName": "",
      "assignee": "",
      "candidateUsers": "",
      "candidateGroups": "",
      "applicant": false,
      "ccFlag": false,
      "opinionFlag": false,
      "signatureFlag": false,
      "pageFlag": false,
      "pageUri": ""
    }
  ]
}

execute

接口说明

流程操作

请求地址

POST /magus-camunda/process/task/execute

请求参数

参数名	父级	类型	是否必须	示例值	描述
req		Object
action	req	String	0	Claim	操作类型
procInstId	req	String	0	2907da64-5b47-11ee-913a-a684fe3d13d0	流程实例id
taskId	req	String	0	2907da64-5b47-11ee-913a-a684fe3d13d1	任务id
data	req	Array	0		业务数据
tableKey	data	String	0		表名
tableData	data	Object	0		业务数据
subForms	data	Array	0		子表
authData	data	Array	0		权限
code	authData	String	0		资源类型code
data	authData	Object	0		资源数据
code	data	String	0		资源code
name	data	String	0		资源名称
cc	req	Object	0		抄送
ccId	cc	String	0	admin	抄送人
terminate	req	Object	0		终止
mode	terminate	String	0	AT	模式（AT:自动;MT:手动）
variables	terminate	Object	0		变量
appendixIds	terminate	Array	0		附件
opinion	terminate	String	0	拒绝	意见
delegate	req	Object	0		委托
assignee	delegate	String	0	admin	处理人
jump	req	Object	0		跳转
targetNodeKey	jump	String	0	Activity_1beebwk	目标节点key
variables	jump	Object	0		变量
claim	req	Object	0		认领

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	list	String	id
nodeKey	list	String	节点定义key
nodeName	list	String	节点定义名称
nodeType	list	String	节点类型
procDefId	list	String	流程定义ID
procDefName	list	String	流程定义名称
assignee	list	String	task处理人
candidateUsers	list	String	task候选人参数
candidateGroups	list	String	task候选人组参数
applicant	list	Boolean	是否是申请人节点
ccFlag	list	Boolean	是否启用抄送
opinionFlag	list	Boolean	是否启用意见输入框
signatureFlag	list	Boolean	是否启用手写签名
pageFlag	list	Boolean	是否是内部表单：默认true
pageUri	list	String	页面uri

请求示例

{
  "action": "",
  "procInstId": "",
  "taskId": "",
  "data": [
    {
      "tableKey": "",
      "tableData": [
        {}
      ],
      "authData": [
        {
          "code": "",
          "data": [
            {
              "code": "",
              "name": ""
            }
          ]
        }
      ],
      "subForms": []
    }
  ],
  "cc": {
    "ccId": ""
  },
  "terminate": {
    "mode": "",
    "variables": {},
    "appendixIds": [
      ""
    ],
    "opinion": ""
  },
  "delegate": {
    "assignee": "",
  },
  "jump": {
    "targetNodeKey": "",
    "variables": {}
  },
  "claim": {}
}

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true
}

ProcessActionRestApi

com.magus.cloud.camunda.client.api.ProcessActionRestApi

listByTaskId

接口说明

获取任务下所有操作

请求地址

GET /magus-camunda/process/action/list-by-taskId/{taskId}

请求参数

参数名	父级	类型	是否必须	示例值	描述
taskId		String	1		任务id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
List		Array
key	list	String	操作key
name	list	String	操作名称
aliasName	list	String	操作别名
sysFlag	list	Boolean	是否是系统默认
action	list	Object	操作信息
key	action	String	操作key
name	action	String	操作名称
sysFlag	action	Boolean	是否是系统默认

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "key": "",
      "name": "",
      "aliasName": "",
      "sysFlag": false,
      "action": {
        "key": "",
        "name": "",
        "sysFlag": false
      }
    }
  ]
}

saveAll

接口说明

保存所有操作

请求地址

POST /magus-camunda/process/action/save-all

请求参数

参数名	父级	类型	是否必须	示例值	描述
req		Object	1		任务id
nodeKey	req	String	1	Activity_0lvx4zp	流程节点的key
code	req	String	1	save	操作的code
name	req	String	1	提交	操作的名称
aliasName	req	String	0	保存	操作的别名
sysFlag	req	Boolean	1	True	是否是系统默认(true:系统；false:自定义)
enable	req	Boolean	1	True	是否授权(true:是；false:否)

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean

请求示例

{
  "nodeKey": "",
  "code": "",
  "name": "",
  "aliasName": "",
  "sysFlag": false,
  "enable": false
}

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true
}

ProcessActivityRecordRestApi

com.magus.cloud.camunda.client.api.ProcessActivityRecordRestApi

listByProcInstId

接口说明

获取流程实例下的所有的活动动态

请求地址

GET /magus-camunda/process/record/list-by-procInstId/{procInstId}

请求参数

参数名	父级	类型	是否必须	示例值	描述
procInstId		String	1		流程实例id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
List		Array
taskId	list	String	任务id
procInstId	list	String	流程实例id
activityStatus	list	String	活动状态
opinion	list	String	意见
appendixIds	list	String	附件id
operatorId	list	String	操作人id
operator	list	String	操作人姓名
sort	list	Integer	排序
status	list	String	状态
createId	list	String	创建人id
updateTime	list	String	更新时间
appendices	list	Array	附件
id	appendices	String	附件id
fileName	appendices	String	附件名
fileSize	appendices	String	附件大小
fileType	appendices	String	附件类型
appCode	appendices	String	应用code
bizKey	appendices	String	业务主键
targetCode	appendices	String	存储目标主键
tags	appendices	String	标签
storePath	appendices	String	文件存储路径
remark	appendices	String	备注
fileUrl	appendices	String	文件路径

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "taskId": "",
      "procInstId": "",
      "activityStatus": "",
      "opinion": "",
      "appendixIds": "",
      "operatorId": "",
      "operator": "",
      "sort": 0,
      "status": "",
      "createId": "",
      "updateTime": "2023-11-22 09:08:03",
      "appendices": [
        {
          "id": "",
          "fileName": "",
          "fileSize": "",
          "fileType": "",
          "appCode": "",
          "bizKey": "",
          "targetCode": "",
          "tags": "",
          "storePath": "",
          "remark": "",
          "fileUrl": ""
        }
      ]
    }
  ]
}

ProcessCommentRestApi

com.magus.cloud.camunda.client.api.ProcessCommentRestApi

listByProcInstId

接口说明

获取对应流程实例的评论

请求地址

GET /magus-camunda/process/comment/list-by-procInstId/{procInstId}

请求参数

参数名	父级	类型	是否必须	示例值	描述
procInstId		String	1		流程实例id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	list	String	任务id
createTime	list	Date	评论时间
procInstId	list	String	流程实例id
comment	list	String	评论
createUserName	list	String	评论人

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true,
  "list": [
    {
      "id": "",
      "createTime": "2023-11-22 09:08:03",
      "procInstId": "",
      "comment": "",
      "createUserName": ""
    }
  ]
}

Create

接口说明

添加评论

请求地址

POST /magus-camunda/process/comment/create

请求参数

参数名	父级	类型	是否必须	示例值	描述
req		Object	1
procInstId	req	String	0	b7590e88-9bac-4588-b8a5-e43fa70d9d05	流程实例id
comment	req	String	0	同意	评论
createUserName	req	String	0	王乐乐	创建人名称

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean
list		Array
id	list	String	任务id
createTime	list	Date	评论时间
procInstId	list	String	流程实例id
comment	list	String	评论
createUserName	list	String	评论人

请求示例

{
  "procInstId": "",
  "comment": "",
  "createUserName": ""
}

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true
}

listByProcInstId

接口说明

获取对应流程实例的评论

请求地址

POST /magus-camunda/process/comment/delete/{id}

请求参数

参数名	父级	类型	是否必须	示例值	描述
id		String	1		评论id

响应状态

状态码	说明	schema
200	OK
500	服务响应异常	CommonRsp

响应参数

参数名称	父级	类型	参数说明
result		BaseRspResult	BaseRspResult
bizCode	result	integer(int32)	业务代码，表示操作结果代码
resultCode	result	string	系统代码，表示操作结果,可用值:SUCCESS(0),FAIL_SYSTEM(1),FAIL_BUSINESS(2)
message	result	string	错误信息
validResults	result	array	表单校验错误对象
propertyPath	validResults	string	表单校验错误字段
message	validResults		表单校验错误消息
rspFlag		boolean

请求示例

响应示例

{
  "result": {
    "bizCode": 0,
    "resultCode": "",
    "message": "",
    "validResults": [
      {
        "propertyPath": "",
        "message": ""
      }
    ]
  },
  "rspFlag": true
}

流程中心 ​

ProcessDefinitionRestApi ​

findByProcDefId ​

findByProcDefId ​

findUpProcessByProcDefKey ​

listByProcDefKey ​

pageKey ​

pageId ​

pagePublishProcess ​

onOrOff ​

test ​

upload ​

deleteByProcDefIdIn ​

ProcessInstanceRestApi ​

count ​

page ​

findByid ​

findRunningByProcDefKey ​

findByBusinessId ​

listInBusinessId ​

draft ​

submit ​

submit ​

update ​

deleteByBusinessIdIn ​

delete ​

ProcessNodeRestApi ​

listByProcDefId ​

ProcessTaskRestApi ​

listByTaskId ​

execute ​

ProcessActionRestApi ​

listByTaskId ​

saveAll ​

ProcessActivityRecordRestApi ​

listByProcInstId ​

ProcessCommentRestApi ​

listByProcInstId ​

Create ​

listByProcInstId ​

流程中心

ProcessDefinitionRestApi

findByProcDefId

findByProcDefId

findUpProcessByProcDefKey

listByProcDefKey

pageKey

pageId

pagePublishProcess

onOrOff

test

upload

deleteByProcDefIdIn

ProcessInstanceRestApi

count

page

findByid

findRunningByProcDefKey

findByBusinessId

listInBusinessId

draft

submit

submit

update

deleteByBusinessIdIn

delete

ProcessNodeRestApi

listByProcDefId

ProcessTaskRestApi

listByTaskId

execute

ProcessActionRestApi

listByTaskId

saveAll

ProcessActivityRecordRestApi

listByProcInstId

ProcessCommentRestApi

listByProcInstId

Create

listByProcInstId