org.camunda.bpm.engine.rest

Interface CaseInstanceRestService

All Known Implementing Classes:

CaseInstanceRestServiceImpl

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

Author:

Roman Smirnov

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH

Method Summary

Modifier and Type	Method and Description
CaseInstanceResource	getCaseInstance(String caseInstanceId)
List<CaseInstanceDto>	getCaseInstances(javax.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults) Exposes the CaseInstanceQuery interface as a REST service.
CountResultDto	getCaseInstancesCount(javax.ws.rs.core.UriInfo uriInfo)
List<CaseInstanceDto>	queryCaseInstances(CaseInstanceQueryDto query, Integer firstResult, Integer maxResults) Expects the same parameters as getCaseInstances(UriInfo, Integer, Integer) (as a JSON message body) and allows for any number of variable checks.
CountResultDto	queryCaseInstancesCount(CaseInstanceQueryDto query)

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

Method Detail

getCaseInstance

@Path(value="/{id}")
CaseInstanceResource getCaseInstance(@PathParam(value="id")
                                                          String caseInstanceId)

getCaseInstances

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

Exposes the CaseInstanceQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

queryCaseInstances

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
List<CaseInstanceDto> queryCaseInstances(CaseInstanceQueryDto query,
                                                                                                                         @QueryParam(value="firstResult")
                                                                                                                         Integer firstResult,
                                                                                                                         @QueryParam(value="maxResults")
                                                                                                                         Integer maxResults)

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

Parameters:

query -

firstResult -

maxResults -

Returns:

getCaseInstancesCount

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

queryCaseInstancesCount

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