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 final String	PATH

Method Summary

Modifier and Type	Method	Description
List<HistoricDetailDto>	getHistoricDetails(jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults, boolean deserializeObjectValues)	Exposes the HistoricActivityInstanceQuery interface as a REST service.
CountResultDto	getHistoricDetailsCount(jakarta.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 Details

PATH

static final String PATH

See Also:

• Constant Field Values

Method Details

historicDetail

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

getHistoricDetails

@GET
@Produces("application/json")
List<HistoricDetailDto> getHistoricDetails(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @QueryParam("firstResult")
 Integer firstResult,
 @QueryParam("maxResults")
 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")
List<HistoricDetailDto> queryHistoricDetails(HistoricDetailQueryDto queryDto,
 @QueryParam("firstResult")
 Integer firstResult,
 @QueryParam("maxResults")
 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
 jakarta.ws.rs.core.UriInfo uriInfo)