Package org.camunda.bpm.engine.rest
Interface CaseInstanceRestService
- All Known Implementing Classes:
CaseInstanceRestServiceImpl
@Produces("application/json")
public interface CaseInstanceRestService
- Author:
- Roman Smirnov
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetCaseInstance
(String caseInstanceId) getCaseInstances
(jakarta.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults) Exposes theCaseInstanceQuery
interface as a REST service.getCaseInstancesCount
(jakarta.ws.rs.core.UriInfo uriInfo) queryCaseInstances
(CaseInstanceQueryDto query, Integer firstResult, Integer maxResults) Expects the same parameters asgetCaseInstances(UriInfo, Integer, Integer)
(as a JSON message body) and allows for any number of variable checks.
-
Field Details
-
PATH
- See Also:
-
-
Method Details
-
getCaseInstance
-
getCaseInstances
@GET @Produces("application/json") List<CaseInstanceDto> getCaseInstances(@Context jakarta.ws.rs.core.UriInfo uriInfo, @QueryParam("firstResult") Integer firstResult, @QueryParam("maxResults") Integer maxResults) Exposes theCaseInstanceQuery
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 asgetCaseInstances(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)
-