org.camunda.bpm.engine.rest.history

Interface HistoricVariableInstanceRestService

All Known Implementing Classes:

HistoricVariableInstanceRestServiceImpl

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH

Method Summary

Modifier and Type	Method and 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(value="/{id}")
HistoricVariableInstanceResource variableInstanceResource(@PathParam(value="id")
                                                                               String id)

getHistoricVariableInstances

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

Exposes the HistoricVariableInstanceQuery interface as a REST service.

Parameters:

query -

firstResult -

maxResults -

Returns:

queryHistoricVariableInstances

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

Parameters:

query -

firstResult -

maxResults -

Returns:

getHistoricVariableInstancesCount

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

queryHistoricVariableInstancesCount

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