Package org.camunda.bpm.engine.rest.history

Interface HistoricVariableInstanceRestService

All Known Implementing Classes:

HistoricVariableInstanceRestServiceImpl

@Path("/variable-instance")
@Produces("application/json")
public interface HistoricVariableInstanceRestService

Field Summary

Fields

Modifier and Type	Field	Description
static String	PATH

Method Summary

Modifier and Type	Method	Description
List<HistoricVariableInstanceDto>	getHistoricVariableInstances(javax.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults, boolean deserializeValues)	Exposes the HistoricVariableInstanceQuery interface as a REST service.
CountResultDto	getHistoricVariableInstancesCount(javax.ws.rs.core.UriInfo uriInfo)
List<HistoricVariableInstanceDto>	queryHistoricVariableInstances(HistoricVariableInstanceQueryDto query, Integer firstResult, Integer maxResults, boolean deserializeValues)
CountResultDto	queryHistoricVariableInstancesCount(HistoricVariableInstanceQueryDto query)
HistoricVariableInstanceResource	variableInstanceResource(String id)

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

Method Detail

variableInstanceResource

@Path("/{id}")
HistoricVariableInstanceResource variableInstanceResource(@PathParam("id")
                                                          String id)

getHistoricVariableInstances

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

Exposes the HistoricVariableInstanceQuery interface as a REST service.

Parameters:

query -

firstResult -

maxResults -

Returns:

queryHistoricVariableInstances

@POST
@Consumes("application/json")
@Produces("application/json")
List<HistoricVariableInstanceDto> queryHistoricVariableInstances(HistoricVariableInstanceQueryDto query,
                                                                 @QueryParam("firstResult")
                                                                 Integer firstResult,
                                                                 @QueryParam("maxResults")
                                                                 Integer maxResults,
                                                                 @QueryParam("deserializeValues") @DefaultValue("true")
                                                                 boolean deserializeValues)

Parameters:

query -

firstResult -

maxResults -

Returns:

getHistoricVariableInstancesCount

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

queryHistoricVariableInstancesCount

@POST
@Path("/count")
@Consumes("application/json")
@Produces("application/json")
CountResultDto queryHistoricVariableInstancesCount(HistoricVariableInstanceQueryDto query)