org.camunda.bpm.engine.rest

Interface CaseExecutionRestService

All Known Implementing Classes:

CaseExecutionRestServiceImpl

@Produces(value="application/json")
public interface CaseExecutionRestService

Author:

Roman Smirnov

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH

Method Summary

Modifier and Type	Method and Description
CaseExecutionResource	getCaseExecution(String caseExecutionId)
List<CaseExecutionDto>	getCaseExecutions(javax.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults) Exposes the CaseExecutionQuery interface as a REST service.
CountResultDto	getCaseExecutionsCount(javax.ws.rs.core.UriInfo uriInfo)
List<CaseExecutionDto>	queryCaseExecutions(CaseExecutionQueryDto query, Integer firstResult, Integer maxResults) Expects the same parameters as getCaseExecutions(UriInfo, Integer, Integer) (as a JSON message body) and allows for any number of variable checks.
CountResultDto	queryCaseExecutionsCount(CaseExecutionQueryDto query)

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

Method Detail

getCaseExecution

@Path(value="/{id}")
CaseExecutionResource getCaseExecution(@PathParam(value="id")
                                                            String caseExecutionId)

getCaseExecutions

@GET
 @Produces(value="application/json")
List<CaseExecutionDto> getCaseExecutions(@Context
                                                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                                                   @QueryParam(value="firstResult")
                                                                                   Integer firstResult,
                                                                                   @QueryParam(value="maxResults")
                                                                                   Integer maxResults)

Exposes the CaseExecutionQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

queryCaseExecutions

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
List<CaseExecutionDto> queryCaseExecutions(CaseExecutionQueryDto query,
                                                                                                                           @QueryParam(value="firstResult")
                                                                                                                           Integer firstResult,
                                                                                                                           @QueryParam(value="maxResults")
                                                                                                                           Integer maxResults)

Expects the same parameters as getCaseExecutions(UriInfo, Integer, Integer) (as a JSON message body) and allows for any number of variable checks.

Parameters:

query -

firstResult -

maxResults -

Returns:

getCaseExecutionsCount

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

queryCaseExecutionsCount

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