Package org.camunda.bpm.engine.rest

Interface VariableInstanceRestService

All Known Implementing Classes:

VariableInstanceRestServiceImpl

@Produces("application/json")
public interface VariableInstanceRestService

Author:

roman.smirnov

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH

Method Summary

Modifier and Type	Method	Description
VariableInstanceResource	getVariableInstance(String id)
List<VariableInstanceDto>	getVariableInstances(jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults, boolean deserializeObjectValues)	Exposes the VariableInstanceQuery interface as a REST service.
CountResultDto	getVariableInstancesCount(jakarta.ws.rs.core.UriInfo uriInfo)
List<VariableInstanceDto>	queryVariableInstances(VariableInstanceQueryDto queryDto, Integer firstResult, Integer maxResults, boolean deserializeObjectValues)	Expects the same parameters as VariableInstanceRestService#getVariableInstances(UriInfo, Integer, Integer) (as a JSON message body) and allows for any number of variable checks.
CountResultDto	queryVariableInstancesCount(VariableInstanceQueryDto queryDto)

Field Details

PATH

static final String PATH

See Also:

• Constant Field Values

Method Details

getVariableInstance

@Path("/{id}")
VariableInstanceResource getVariableInstance(@PathParam("id")
 String id)

getVariableInstances

@GET
@Produces("application/json")
List<VariableInstanceDto> getVariableInstances(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @QueryParam("firstResult")
 Integer firstResult,
 @QueryParam("maxResults")
 Integer maxResults,
 @QueryParam("deserializeValues") @DefaultValue("true")
 boolean deserializeObjectValues)

Exposes the VariableInstanceQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

queryVariableInstances

@POST
@Consumes("application/json")
@Produces("application/json")
List<VariableInstanceDto> queryVariableInstances(VariableInstanceQueryDto queryDto,
 @QueryParam("firstResult")
 Integer firstResult,
 @QueryParam("maxResults")
 Integer maxResults,
 @QueryParam("deserializeValues") @DefaultValue("true")
 boolean deserializeObjectValues)

Expects the same parameters as VariableInstanceRestService#getVariableInstances(UriInfo, Integer, Integer) (as a JSON message body) and allows for any number of variable checks.

Parameters:

queryDto -

firstResult -

maxResults -

Returns:

getVariableInstancesCount

@GET
@Path("/count")
@Produces("application/json")
CountResultDto getVariableInstancesCount(@Context
 jakarta.ws.rs.core.UriInfo uriInfo)

queryVariableInstancesCount

@POST
@Path("/count")
@Consumes("application/json")
@Produces("application/json")
CountResultDto queryVariableInstancesCount(VariableInstanceQueryDto queryDto)