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

Interface HistoricDetailRestService

All Known Implementing Classes:

HistoricDetailRestServiceImpl

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

Author:

Roman Smirnov

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PATH

Method Summary

Modifier and Type	Method	Description
java.util.List<HistoricDetailDto>	getHistoricDetails(javax.ws.rs.core.UriInfo uriInfo, java.lang.Integer firstResult, java.lang.Integer maxResults, boolean deserializeObjectValues)	Exposes the HistoricActivityInstanceQuery interface as a REST service.
CountResultDto	getHistoricDetailsCount(javax.ws.rs.core.UriInfo uriInfo)
HistoricDetailResource	historicDetail(java.lang.String detailId)
java.util.List<HistoricDetailDto>	queryHistoricDetails(HistoricDetailQueryDto queryDto, java.lang.Integer firstResult, java.lang.Integer maxResults, boolean deserializeObjectValues)	Exposes the HistoricActivityInstanceQuery interface as a REST service with additional query parameters (compared to the GET alternative).

Field Detail

PATH

static final java.lang.String PATH

See Also:

Constant Field Values

Method Detail

historicDetail

@Path("/{id}")
HistoricDetailResource historicDetail(@PathParam("id")
                                      java.lang.String detailId)

getHistoricDetails

@GET
@Produces("application/json")
java.util.List<HistoricDetailDto> getHistoricDetails(@Context
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     @QueryParam("firstResult")
                                                     java.lang.Integer firstResult,
                                                     @QueryParam("maxResults")
                                                     java.lang.Integer maxResults,
                                                     @QueryParam("deserializeValues") @DefaultValue("true")
                                                     boolean deserializeObjectValues)

Exposes the HistoricActivityInstanceQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

queryHistoricDetails

@POST
@Consumes("application/json")
@Produces("application/json")
java.util.List<HistoricDetailDto> queryHistoricDetails(HistoricDetailQueryDto queryDto,
                                                       @QueryParam("firstResult")
                                                       java.lang.Integer firstResult,
                                                       @QueryParam("maxResults")
                                                       java.lang.Integer maxResults,
                                                       @QueryParam("deserializeValues") @DefaultValue("true")
                                                       boolean deserializeObjectValues)

Exposes the HistoricActivityInstanceQuery interface as a REST service with additional query parameters (compared to the GET alternative).

Parameters:

queryDto -

firstResult -

maxResults -

Returns:

getHistoricDetailsCount

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