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 and Description
static String	DESERIALIZE_VALUE_QUERY_PARAM
static String	DESERIALIZE_VALUES_QUERY_PARAM

Method Summary

Modifier and Type	Method and Description
void	deleteVariable(String variableName)
VariableValueDto	getVariable(String variableName, boolean deserializeValue)
javax.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 Detail

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 Detail

getVariables

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

getVariable

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

getVariableBinary

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

putVariable

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

setBinaryVariable

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

deleteVariable

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

modifyVariables

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