程序包 net.risesoft.api.processadmin

接口 VariableApi

public interface VariableApi

正在运行变量相关接口

作者:

qinman, zhangchongjie

Date:

2022/12/19

方法概要

修饰符和类型	方法	说明
net.risesoft.pojo.Y9Result<Object>	deleteVariable(String tenantId, String taskId, String key)	删除流程变量
net.risesoft.pojo.Y9Result<Object>	deleteVariableLocal(String tenantId, String taskId, String key)	删除任务变量
net.risesoft.pojo.Y9Result<String>	getVariable(String tenantId, String taskId, String key)	获取流程变量
net.risesoft.pojo.Y9Result<String>	getVariableByProcessInstanceId(String tenantId, String processInstanceId, String key)	获取流程变量
net.risesoft.pojo.Y9Result<String>	getVariableLocal(String tenantId, String taskId, String key)	获取任务变量
net.risesoft.pojo.Y9Result<Map<String,Object>>	getVariables(String tenantId, String taskId)	获取多个流程变量
net.risesoft.pojo.Y9Result<Map<String,Object>>	getVariablesByProcessInstanceId(String tenantId, String processInstanceId, Collection<String> keys)	获取指定的流程变量
net.risesoft.pojo.Y9Result<Map<String,Object>>	getVariablesLocal(String tenantId, String taskId)	获取所有任务变量
net.risesoft.pojo.Y9Result<Object>	setVariable(String tenantId, String taskId, String key, Map<String,Object> map)	设置流程变量
net.risesoft.pojo.Y9Result<Object>	setVariableByProcessInstanceId(String tenantId, String processInstanceId, String key, Map<String,Object> map)	设置流程变量
net.risesoft.pojo.Y9Result<Object>	setVariableLocal(String tenantId, String taskId, String key, Map<String,Object> map)	设置任务变量
net.risesoft.pojo.Y9Result<Object>	setVariables(String tenantId, String taskId, Map<String,Object> map)	设置多个流程变量
net.risesoft.pojo.Y9Result<Object>	setVariablesLocal(String tenantId, String taskId, Map<String,Object> map)	设置多个任务变量

方法详细资料

deleteVariable

@PostMapping("/deleteVariable")
net.risesoft.pojo.Y9Result<Object> deleteVariable(@RequestParam("tenantId")
                                                  String tenantId,
                                                  @RequestParam("taskId")
                                                  String taskId,
                                                  @RequestParam("key")
                                                  String key)

删除流程变量

参数:

tenantId - 租户id

taskId - 任务id

key - 变量key

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

deleteVariableLocal

@PostMapping("/deleteVariableLocal")
net.risesoft.pojo.Y9Result<Object> deleteVariableLocal(@RequestParam("tenantId")
                                                       String tenantId,
                                                       @RequestParam("taskId")
                                                       String taskId,
                                                       @RequestParam("key")
                                                       String key)

删除任务变量

参数:

tenantId - 租户id

taskId - 任务id

key - 变量key

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

getVariable

@GetMapping("/getVariable")
net.risesoft.pojo.Y9Result<String> getVariable(@RequestParam("tenantId")
                                               String tenantId,
                                               @RequestParam("taskId")
                                               String taskId,
                                               @RequestParam("key")
                                               String key)

获取流程变量

参数:

tenantId - 租户id

taskId - 任务id

key - 变量key

返回:

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

从以下版本开始:

9.6.6

getVariableByProcessInstanceId

@GetMapping("/getVariableByProcessInstanceId")
net.risesoft.pojo.Y9Result<String> getVariableByProcessInstanceId(@RequestParam("tenantId")
                                                                  String tenantId,
                                                                  @RequestParam("processInstanceId")
                                                                  String processInstanceId,
                                                                  @RequestParam("key")
                                                                  String key)

获取流程变量

参数:

tenantId - 租户id

processInstanceId - 流程id

key - 变量key

返回:

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

从以下版本开始:

9.6.6

getVariableLocal

@GetMapping("/getVariableLocal")
net.risesoft.pojo.Y9Result<String> getVariableLocal(@RequestParam("tenantId")
                                                    String tenantId,
                                                    @RequestParam("taskId")
                                                    String taskId,
                                                    @RequestParam("key")
                                                    String key)

获取任务变量

参数:

tenantId - 租户id

taskId - 任务id

key - 变量key

返回:

Y9Result<String> 通用请求返回对象 - data 是任务变量

从以下版本开始:

9.6.6

getVariables

@GetMapping("/getVariables")
net.risesoft.pojo.Y9Result<Map<String,Object>> getVariables(@RequestParam("tenantId")
                                                                  String tenantId,
                                                                  @RequestParam("taskId")
                                                                  String taskId)

获取多个流程变量

参数:

tenantId - 租户id

taskId - 任务id

返回:

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

从以下版本开始:

9.6.6

getVariablesByProcessInstanceId

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

获取指定的流程变量

参数:

tenantId - 租户id

processInstanceId - 流程实例id

keys - 变量keys

返回:

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

从以下版本开始:

9.6.6

getVariablesLocal

@GetMapping("/getVariablesLocal")
net.risesoft.pojo.Y9Result<Map<String,Object>> getVariablesLocal(@RequestParam("tenantId")
                                                                       String tenantId,
                                                                       @RequestParam("taskId")
                                                                       String taskId)

获取所有任务变量

参数:

tenantId - 租户id

taskId - 任务id

返回:

Y9Result<Map<String, Object>> 通用请求返回对象 - data 是任务变量

从以下版本开始:

9.6.6

setVariable

@PostMapping(value="/setVariable",
             consumes="application/json")
net.risesoft.pojo.Y9Result<Object> setVariable(@RequestParam("tenantId")
                                               String tenantId,
                                               @RequestParam("taskId")
                                               String taskId,
                                               @RequestParam("key")
                                               String key,
                                               @RequestBody
                                               Map<String,Object> map)

设置流程变量

参数:

tenantId - 租户id

taskId - 任务id

key - 变量key

map - 变量值

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

setVariableByProcessInstanceId

@PostMapping(value="/setVariableByProcessInstanceId",
             consumes="application/json")
net.risesoft.pojo.Y9Result<Object> setVariableByProcessInstanceId(@RequestParam("tenantId")
                                                                  String tenantId,
                                                                  @RequestParam("processInstanceId")
                                                                  String processInstanceId,
                                                                  @RequestParam("key")
                                                                  String key,
                                                                  @RequestBody
                                                                  Map<String,Object> map)

设置流程变量

参数:

tenantId - 租户id

processInstanceId - 流程实例id

key - 变量key

map - 变量值

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

setVariableLocal

@PostMapping(value="/setVariableLocal",
             consumes="application/json")
net.risesoft.pojo.Y9Result<Object> setVariableLocal(@RequestParam("tenantId")
                                                    String tenantId,
                                                    @RequestParam("taskId")
                                                    String taskId,
                                                    @RequestParam("key")
                                                    String key,
                                                    @RequestBody
                                                    Map<String,Object> map)

设置任务变量

参数:

tenantId - 租户id

taskId - 任务id

key - 变量key

map - 变量值

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

setVariables

@PostMapping(value="/setVariables",
             consumes="application/json")
net.risesoft.pojo.Y9Result<Object> setVariables(@RequestParam("tenantId")
                                                String tenantId,
                                                @RequestParam("taskId")
                                                String taskId,
                                                @RequestBody
                                                Map<String,Object> map)

设置多个流程变量

参数:

tenantId - 租户id

taskId - 任务id

map - 变量map

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

setVariablesLocal

@PostMapping(value="/setVariablesLocal",
             consumes="application/json")
net.risesoft.pojo.Y9Result<Object> setVariablesLocal(@RequestParam("tenantId")
                                                     String tenantId,
                                                     @RequestParam("taskId")
                                                     String taskId,
                                                     @RequestBody
                                                     Map<String,Object> map)

设置多个任务变量

参数:

tenantId - 租户id

taskId - 任务id

map - 变量map

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6