org.camunda.bpm.engine.rest.history

Interface HistoricDetailRestService

All Known Implementing Classes:

HistoricDetailRestServiceImpl

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

Author:

Roman Smirnov

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH

Method Summary

Modifier and Type	Method and Description
List<HistoricDetailDto>	getHistoricDetails(javax.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults, boolean deserializeObjectValues) Exposes the HistoricActivityInstanceQuery interface as a REST service.
CountResultDto	getHistoricDetailsCount(javax.ws.rs.core.UriInfo uriInfo)
HistoricDetailResource	historicDetail(String detailId)
List<HistoricDetailDto>	queryHistoricDetails(HistoricDetailQueryDto queryDto, Integer firstResult, 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 String PATH

See Also:

Constant Field Values

Method Detail

historicDetail

@Path(value="/{id}")
HistoricDetailResource historicDetail(@PathParam(value="id")
                                                           String detailId)

getHistoricDetails

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

Exposes the HistoricActivityInstanceQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

queryHistoricDetails

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
List<HistoricDetailDto> queryHistoricDetails(HistoricDetailQueryDto queryDto,
                                                                                                                             @QueryParam(value="firstResult")
                                                                                                                             Integer firstResult,
                                                                                                                             @QueryParam(value="maxResults")
                                                                                                                             Integer maxResults,
                                                                                                                             @QueryParam(value="deserializeValues") @DefaultValue(value="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(value="/count")
 @Produces(value="application/json")
CountResultDto getHistoricDetailsCount(@Context
                                                                                                        javax.ws.rs.core.UriInfo uriInfo)