Package org.camunda.bpm.engine.rest

Interface CaseDefinitionRestService

All Known Implementing Classes:

CaseDefinitionRestServiceImpl

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

Author:

Roman Smirnov

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PATH

Method Summary

Modifier and Type	Method	Description
CaseDefinitionResource	getCaseDefinitionById(java.lang.String caseDefinitionId)
CaseDefinitionResource	getCaseDefinitionByKey(java.lang.String caseDefinitionKey)
CaseDefinitionResource	getCaseDefinitionByKeyAndTenantId(java.lang.String caseDefinitionKey, java.lang.String tenantId)
java.util.List<CaseDefinitionDto>	getCaseDefinitions(javax.ws.rs.core.UriInfo uriInfo, java.lang.Integer firstResult, java.lang.Integer maxResults)	Exposes the CaseDefinitionQuery interface as a REST service.
CountResultDto	getCaseDefinitionsCount(javax.ws.rs.core.UriInfo uriInfo)

Field Detail

PATH

static final java.lang.String PATH

See Also:

Constant Field Values

Method Detail

getCaseDefinitionById

@Path("/{id}")
CaseDefinitionResource getCaseDefinitionById(@PathParam("id")
                                             java.lang.String caseDefinitionId)

getCaseDefinitionByKey

@Path("/key/{key}")
CaseDefinitionResource getCaseDefinitionByKey(@PathParam("key")
                                              java.lang.String caseDefinitionKey)

getCaseDefinitionByKeyAndTenantId

@Path("/key/{key}/tenant-id/{tenantId}")
CaseDefinitionResource getCaseDefinitionByKeyAndTenantId(@PathParam("key")
                                                         java.lang.String caseDefinitionKey,
                                                         @PathParam("tenantId")
                                                         java.lang.String tenantId)

getCaseDefinitions

@GET
@Produces("application/json")
java.util.List<CaseDefinitionDto> getCaseDefinitions(@Context
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     @QueryParam("firstResult")
                                                     java.lang.Integer firstResult,
                                                     @QueryParam("maxResults")
                                                     java.lang.Integer maxResults)

Exposes the CaseDefinitionQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

getCaseDefinitionsCount

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