Package org.camunda.bpm.engine.rest.sub

Interface VariableResource

All Known Implementing Classes:

AbstractVariablesResource, CaseExecutionVariablesResource, ExecutionVariablesResource, LocalCaseExecutionVariablesResource, LocalExecutionVariablesResource, LocalTaskVariablesResource, TaskVariablesResource

public interface VariableResource

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESERIALIZE_VALUE_QUERY_PARAM
static final String	DESERIALIZE_VALUES_QUERY_PARAM

Method Summary

Modifier and Type	Method	Description
void	deleteVariable(String variableName)
VariableValueDto	getVariable(String variableName, boolean deserializeValue)
jakarta.ws.rs.core.Response	getVariableBinary(String variableName)
Map<String,VariableValueDto>	getVariables(boolean deserializeValues)
void	modifyVariables(PatchVariablesDto patch)
void	putVariable(String variableName, VariableValueDto variable)
void	setBinaryVariable(String variableName, MultipartFormData multipartFormData)

Field Details

DESERIALIZE_VALUE_QUERY_PARAM

static final String DESERIALIZE_VALUE_QUERY_PARAM

See Also:

• Constant Field Values

DESERIALIZE_VALUES_QUERY_PARAM

static final String DESERIALIZE_VALUES_QUERY_PARAM

See Also:

• Constant Field Values

Method Details

getVariables

@GET
@Produces("application/json")
Map<String,VariableValueDto> getVariables(@QueryParam("deserializeValues") @DefaultValue("true")
 boolean deserializeValues)

getVariable

@GET
@Path("/{varId}")
@Produces("application/json")
VariableValueDto getVariable(@PathParam("varId")
 String variableName,
 @QueryParam("deserializeValue") @DefaultValue("true")
 boolean deserializeValue)

getVariableBinary

@GET
@Path("/{varId}/data")
jakarta.ws.rs.core.Response getVariableBinary(@PathParam("varId")
 String variableName)

putVariable

@PUT
@Path("/{varId}")
@Consumes("application/json")
void putVariable(@PathParam("varId")
 String variableName,
 VariableValueDto variable)

setBinaryVariable

@POST
@Path("/{varId}/data")
@Consumes("multipart/form-data")
void setBinaryVariable(@PathParam("varId")
 String variableName,
 MultipartFormData multipartFormData)

deleteVariable

@DELETE
@Path("/{varId}")
void deleteVariable(@PathParam("varId")
 String variableName)

modifyVariables

@POST
@Consumes("application/json")
void modifyVariables(PatchVariablesDto patch)