程序包 net.risesoft.api.processadmin

接口 HistoricVariableApi

public interface HistoricVariableApi

历史变量相关接口

作者:

qinman, zhangchongjie

Date:

2022/12/19

方法概要

修饰符和类型	方法	说明
net.risesoft.pojo.Y9Result<List<HistoricVariableInstanceModel>>	getByProcessInstanceId(String tenantId, String processInstanceId)	根据流程实例Id,获取历史流程变量集合
net.risesoft.pojo.Y9Result<HistoricVariableInstanceModel>	getByProcessInstanceIdAndVariableName(String tenantId, String processInstanceId, String variableName, String year)	根据流程实例Id和流程变量的Key,获取历史流程变量的值
net.risesoft.pojo.Y9Result<List<HistoricVariableInstanceModel>>	getByTaskId(String tenantId, String taskId)	根据任务Id,获取历史任务变量的值集合
net.risesoft.pojo.Y9Result<HistoricVariableInstanceModel>	getByTaskIdAndVariableName(String tenantId, String taskId, String variableName, String year)	根据任务Id和变量Key,获取历史任务变量的值
net.risesoft.pojo.Y9Result<Map<String,Object>>	getVariables(String tenantId, String processInstanceId, Collection<String> keys)	根据流程实例Id,获取指定的流程变量

方法详细资料

getByProcessInstanceId

@GetMapping("/getByProcessInstanceId")
net.risesoft.pojo.Y9Result<List<HistoricVariableInstanceModel>> getByProcessInstanceId(@RequestParam("tenantId")
                                                                                       String tenantId,
                                                                                       @RequestParam("processInstanceId")
                                                                                       String processInstanceId)

根据流程实例Id,获取历史流程变量集合

参数:

tenantId - 租户id

processInstanceId - 流程实例id

返回:

Y9Result<List<HistoricVariableInstanceModel>> 通用请求返回对象 - data 历史任务变量的值列表

从以下版本开始:

9.6.6

getByProcessInstanceIdAndVariableName

@GetMapping("/getByProcessInstanceIdAndVariableName")
net.risesoft.pojo.Y9Result<HistoricVariableInstanceModel> getByProcessInstanceIdAndVariableName(@RequestParam("tenantId")
                                                                                                String tenantId,
                                                                                                @RequestParam("processInstanceId")
                                                                                                String processInstanceId,
                                                                                                @RequestParam("variableName")
                                                                                                String variableName,
                                                                                                @RequestParam(value="year",required=false)
                                                                                                String year)

根据流程实例Id和流程变量的Key,获取历史流程变量的值

参数:

tenantId - 租户id

processInstanceId - 流程实例id

variableName - 变量名

year - 年份

返回:

Y9Result<HistoricVariableInstanceModel> 通用请求返回对象 - data 历史任务变量的值

从以下版本开始:

9.6.6

getByTaskId

@GetMapping("/getByTaskId")
net.risesoft.pojo.Y9Result<List<HistoricVariableInstanceModel>> getByTaskId(@RequestParam("tenantId")
                                                                            String tenantId,
                                                                            @RequestParam("taskId")
                                                                            String taskId)

根据任务Id,获取历史任务变量的值集合

参数:

tenantId - 租户id

taskId - 任务id

返回:

Y9Result<List<HistoricVariableInstanceModel>> 通用请求返回对象 - data 历史任务变量的值列表

从以下版本开始:

9.6.6

getByTaskIdAndVariableName

@GetMapping("/getByTaskIdAndVariableName")
net.risesoft.pojo.Y9Result<HistoricVariableInstanceModel> getByTaskIdAndVariableName(@RequestParam("tenantId")
                                                                                     String tenantId,
                                                                                     @RequestParam("taskId")
                                                                                     String taskId,
                                                                                     @RequestParam("variableName")
                                                                                     String variableName,
                                                                                     @RequestParam(value="year",required=false)
                                                                                     String year)

根据任务Id和变量Key,获取历史任务变量的值

参数:

tenantId - 租户id

taskId - 任务id

variableName - 变量名

year - 年份

返回:

Y9Result<HistoricVariableInstanceModel> 通用请求返回对象 - data 历史任务变量的值

从以下版本开始:

9.6.6

getVariables

@GetMapping(value="/getVariables",
            consumes="application/json")
net.risesoft.pojo.Y9Result<Map<String,Object>> getVariables(@RequestParam("tenantId")
                                                                  String tenantId,
                                                                  @RequestParam("processInstanceId")
                                                                  String processInstanceId,
                                                                  @RequestBody
                                                                  Collection<String> keys)

根据流程实例Id,获取指定的流程变量

参数:

tenantId - 租户id

processInstanceId - 流程实例id

keys - 变量集合

返回:

Y9Result<Map<String, Object>> 通用请求返回对象 - data 流程变量

从以下版本开始:

9.6.6