Package org.flowable.rest.service.api.runtime.process

Class ProcessInstanceVariableCollectionResource

java.lang.Object

org.flowable.rest.service.api.runtime.process.BaseExecutionVariableResource

org.flowable.rest.service.api.runtime.process.BaseVariableCollectionResource

org.flowable.rest.service.api.runtime.process.ProcessInstanceVariableCollectionResource

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

@RestController
public class ProcessInstanceVariableCollectionResource
extends BaseVariableCollectionResource

Author:

Tijs Rademakers

Field Summary

Fields inherited from class org.flowable.rest.service.api.runtime.process.BaseVariableCollectionResource

objectMapper

Fields inherited from class org.flowable.rest.service.api.runtime.process.BaseExecutionVariableResource

env, isSerializableVariableAllowed, restApiInterceptor, restResponseFactory, runtimeService, variableType

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceVariableCollectionResource()

Method Summary

Modifier and Type	Method	Description
protected void	addGlobalVariables(Execution execution, Map<String,RestVariable> variableMap)
protected void	addLocalVariables(Execution execution, Map<String,RestVariable> variableMap)
Object	createExecutionVariable(String processInstanceId, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
Object	createOrUpdateExecutionVariable(String processInstanceId, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	deleteLocalVariables(String processInstanceId)
List<RestVariable>	getVariables(String processInstanceId, String scope)

Methods inherited from class org.flowable.rest.service.api.runtime.process.BaseVariableCollectionResource

createExecutionVariable, deleteAllLocalVariables, processVariables

Methods inherited from class org.flowable.rest.service.api.runtime.process.BaseExecutionVariableResource

afterPropertiesSet, allowProcessInstanceUrl, constructRestVariable, getExecutionFromRequestWithoutAccessCheck, getExecutionIdParameter, getVariableDataByteArray, getVariableFromRequest, getVariableFromRequestWithoutAccessCheck, hasVariableOnScope, setBinaryVariable, setSimpleVariable, setVariable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProcessInstanceVariableCollectionResource

public ProcessInstanceVariableCollectionResource()

Method Details

getVariables

@GetMapping(value="/runtime/process-instances/{processInstanceId}/variables",
            produces="application/json")
public List<RestVariable> getVariables(@PathVariable
 String processInstanceId,
 @RequestParam(value="scope",required=false)
 String scope)

createOrUpdateExecutionVariable

@PutMapping(value="/runtime/process-instances/{processInstanceId}/variables",
            produces="application/json",
            consumes={"application/json","multipart/form-data"})
public Object createOrUpdateExecutionVariable(@PathVariable
 String processInstanceId,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

createExecutionVariable

@PostMapping(value="/runtime/process-instances/{processInstanceId}/variables",
             produces="application/json",
             consumes={"application/json","multipart/form-data"})
public Object createExecutionVariable(@PathVariable
 String processInstanceId,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)

deleteLocalVariables

@DeleteMapping("/runtime/process-instances/{processInstanceId}/variables")
@ResponseStatus(NO_CONTENT)
public void deleteLocalVariables(@PathVariable
 String processInstanceId)

addGlobalVariables

protected void addGlobalVariables(Execution execution,
 Map<String,RestVariable> variableMap)

Overrides:

addGlobalVariables in class BaseVariableCollectionResource

addLocalVariables

protected void addLocalVariables(Execution execution,
 Map<String,RestVariable> variableMap)

Overrides:

addLocalVariables in class BaseVariableCollectionResource