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 java.lang.String	DESERIALIZE_VALUE_QUERY_PARAM
static java.lang.String	DESERIALIZE_VALUES_QUERY_PARAM

Method Summary

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

Field Detail

DESERIALIZE_VALUE_QUERY_PARAM

static final java.lang.String DESERIALIZE_VALUE_QUERY_PARAM

See Also:

Constant Field Values

DESERIALIZE_VALUES_QUERY_PARAM

static final java.lang.String DESERIALIZE_VALUES_QUERY_PARAM

See Also:

Constant Field Values

Method Detail

getVariables

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

getVariable

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

getVariableBinary

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

putVariable

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

setBinaryVariable

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

deleteVariable

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

modifyVariables

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