Package org.camunda.bpm.engine.rest

Interface CaseInstanceRestService

All Known Implementing Classes:

CaseInstanceRestServiceImpl

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

Author:

Roman Smirnov

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH

Method Summary

Modifier and Type	Method	Description
CaseInstanceResource	getCaseInstance(String caseInstanceId)
List<CaseInstanceDto>	getCaseInstances(jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults)	Exposes the CaseInstanceQuery interface as a REST service.
CountResultDto	getCaseInstancesCount(jakarta.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 Details

PATH

static final String PATH

See Also:

• Constant Field Values

Method Details

getCaseInstance

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

getCaseInstances

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

Exposes the CaseInstanceQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

queryCaseInstances

@POST
@Consumes("application/json")
@Produces("application/json")
List<CaseInstanceDto> queryCaseInstances(CaseInstanceQueryDto query,
 @QueryParam("firstResult")
 Integer firstResult,
 @QueryParam("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("/count")
@Produces("application/json")
CountResultDto getCaseInstancesCount(@Context
 jakarta.ws.rs.core.UriInfo uriInfo)

queryCaseInstancesCount

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