程序包 net.risesoft.api.itemadmin

接口 ReminderApi

public interface ReminderApi

催办

作者:

qinman, zhangchongjie

Date:

2022/12/19

方法概要

修饰符和类型	方法	说明
net.risesoft.pojo.Y9Result<Object>	deleteList(String tenantId, String[] ids)	删除催办
net.risesoft.pojo.Y9Result<ReminderModel>	findById(String tenantId, String id)	根据id获取催办
net.risesoft.pojo.Y9Page<ReminderModel>	findByProcessInstanceId(String tenantId, String processInstanceId, int page, int rows)	获取流程实例的催办信息
net.risesoft.pojo.Y9Page<ReminderModel>	findBySenderIdAndProcessInstanceIdAndActive(String tenantId, String senderId, String processInstanceId, int page, int rows)	获取当前催办人的在办任务的催办信息
net.risesoft.pojo.Y9Page<ReminderModel>	findByTaskId(String tenantId, String taskId, int page, int rows)	获取待办的提醒数据
net.risesoft.pojo.Y9Result<ReminderModel>	getReminder(String tenantId, String userId, String taskId, String type)	查看催办信息
net.risesoft.pojo.Y9Result<String>	saveReminder(String tenantId, String userId, String processInstanceId, String[] taskIds, String msgContent)	保存催办信息
net.risesoft.pojo.Y9Result<String>	sendReminderMessage(String tenantId, String userId, String remType, String procInstId, String processInstanceId, String documentTitle, String taskId, String taskAssigneeId, String msgContent)	发送催办信息
net.risesoft.pojo.Y9Result<Object>	setReadTime(String tenantId, String[] ids)	设置为查看状态
net.risesoft.pojo.Y9Result<String>	updateReminder(String tenantId, String id, String msgContent)	更新催办信息

方法详细资料

deleteList

@PostMapping("/deleteList")
net.risesoft.pojo.Y9Result<Object> deleteList(@RequestParam("tenantId")
                                              String tenantId,
                                              @RequestBody
                                              String[] ids)

删除催办

参数:

tenantId - 租户id

ids - 催办ids

返回:

Y9Result<Object> 通用请求返回对象

从以下版本开始:

9.6.6

findById

@GetMapping("/findById")
net.risesoft.pojo.Y9Result<ReminderModel> findById(@RequestParam("tenantId")
                                                   String tenantId,
                                                   @RequestParam("id")
                                                   String id)

根据id获取催办

参数:

tenantId - 租户id

id - 催办id

返回:

Y9Result<ReminderModel> 通用请求返回对象 - rows 是待办的催办信息

从以下版本开始:

9.6.6

findByProcessInstanceId

@GetMapping("/findByProcessInstanceId")
net.risesoft.pojo.Y9Page<ReminderModel> findByProcessInstanceId(@RequestParam("tenantId")
                                                                String tenantId,
                                                                @RequestParam("processInstanceId")
                                                                String processInstanceId,
                                                                @RequestParam("page")
                                                                int page,
                                                                @RequestParam("rows")
                                                                int rows)

获取流程实例的催办信息

参数:

tenantId - 租户id

processInstanceId - 流程实例id

page - 页码

rows - 条数

返回:

Y9Page<ReminderModel> 通用分页请求返回对象 - rows 是催办信息

从以下版本开始:

9.6.6

findBySenderIdAndProcessInstanceIdAndActive

@GetMapping("/findBySenderIdAndProcessInstanceIdAndActive")
net.risesoft.pojo.Y9Page<ReminderModel> findBySenderIdAndProcessInstanceIdAndActive(@RequestParam("tenantId")
                                                                                    String tenantId,
                                                                                    @RequestParam("senderId")
                                                                                    String senderId,
                                                                                    @RequestParam("processInstanceId")
                                                                                    String processInstanceId,
                                                                                    @RequestParam("page")
                                                                                    int page,
                                                                                    @RequestParam("rows")
                                                                                    int rows)

获取当前催办人的在办任务的催办信息

参数:

tenantId - 租户id

senderId - 人员di

processInstanceId - 流程实例id

page - 页码

rows - 条数

返回:

Y9Page<ReminderModel> 通用分页请求返回对象 - rows 是催办信息

从以下版本开始:

9.6.6

findByTaskId

@GetMapping("/findByTaskId")
net.risesoft.pojo.Y9Page<ReminderModel> findByTaskId(@RequestParam("tenantId")
                                                     String tenantId,
                                                     @RequestParam("taskId")
                                                     String taskId,
                                                     @RequestParam("page")
                                                     int page,
                                                     @RequestParam("rows")
                                                     int rows)

获取待办的提醒数据

参数:

tenantId - 租户id

taskId - 任务id

page - 页码

rows - 条数

返回:

Y9Page<ReminderModel> 通用分页请求返回对象 - rows 是待办的催办信息

从以下版本开始:

9.6.6

getReminder

@GetMapping("/getReminder")
net.risesoft.pojo.Y9Result<ReminderModel> getReminder(@RequestParam("tenantId")
                                                      String tenantId,
                                                      @RequestParam("userId")
                                                      String userId,
                                                      @RequestParam("taskId")
                                                      String taskId,
                                                      @RequestParam("type")
                                                      String type)

查看催办信息

参数:

tenantId - 租户id

userId - 人员id

taskId - 任务id

type - 类型，todo（待办），doing（在办），done（办结）

返回:

Y9Result<ReminderModel> 通用请求返回对象 -data 是催办信息

从以下版本开始:

9.6.6

saveReminder

@PostMapping(value="/saveReminder",
             consumes="application/json")
net.risesoft.pojo.Y9Result<String> saveReminder(@RequestParam("tenantId")
                                                String tenantId,
                                                @RequestParam("userId")
                                                String userId,
                                                @RequestParam("processInstanceId")
                                                String processInstanceId,
                                                @RequestBody
                                                String[] taskIds,
                                                @RequestParam("msgContent")
                                                String msgContent)

保存催办信息

参数:

tenantId - 租户id

userId - 人员、岗位id

processInstanceId - 流程实例id

taskIds - taskIds

msgContent - 催办信息

返回:

Y9Result<String> 通用请求返回对象

从以下版本开始:

9.6.6

sendReminderMessage

@PostMapping("/sendReminderMessage")
net.risesoft.pojo.Y9Result<String> sendReminderMessage(@RequestParam("tenantId")
                                                       String tenantId,
                                                       @RequestParam("userId")
                                                       String userId,
                                                       @RequestParam("remType")
                                                       String remType,
                                                       @RequestParam("procInstId")
                                                       String procInstId,
                                                       @RequestParam("processInstanceId")
                                                       String processInstanceId,
                                                       @RequestParam("documentTitle")
                                                       String documentTitle,
                                                       @RequestParam("taskId")
                                                       String taskId,
                                                       @RequestParam("taskAssigneeId")
                                                       String taskAssigneeId,
                                                       @RequestParam("msgContent")
                                                       String msgContent)

发送催办信息

参数:

tenantId - 租户id

userId - 人员、岗位id

remType - 催办类型，"1":短信,"2":邮件",3":站内信",4":待办列表中

procInstId - procInstId

processInstanceId - 流程实例id

documentTitle - 文档标题

taskId - 任务id

taskAssigneeId - 任务受让人Id

msgContent - 催办信息

返回:

Y9Result<String> 通用请求返回对象

从以下版本开始:

9.6.6

setReadTime

@PostMapping(value="/setReadTime",
             consumes="application/json")
net.risesoft.pojo.Y9Result<Object> setReadTime(@RequestParam("tenantId")
                                               String tenantId,
                                               @RequestBody
                                               String[] ids)

设置为查看状态

参数:

tenantId - 租户id

ids - 催办ids

返回:

Y9Result<Object> 通用请求返回对象

从以下版本开始:

9.6.6

updateReminder

@PostMapping("/updateReminder")
net.risesoft.pojo.Y9Result<String> updateReminder(@RequestParam("tenantId")
                                                  String tenantId,
                                                  @RequestParam("id")
                                                  String id,
                                                  @RequestParam("msgContent")
                                                  String msgContent)

更新催办信息

参数:

tenantId - 租户id

id - 催办id

msgContent - 催办信息

返回:

Y9Result<String> 通用请求返回对象

从以下版本开始:

9.6.6