Package org.camunda.bpm.engine.rest

Interface ProcessDefinitionRestService

All Known Implementing Classes:

ProcessDefinitionRestServiceImpl

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	APPLICATION_BPMN20_XML
static javax.ws.rs.core.MediaType	APPLICATION_BPMN20_XML_TYPE
static java.lang.String	PATH

Method Summary

Modifier and Type	Method	Description
void	deleteProcessDefinitionsByKey(java.lang.String processDefinitionKey, boolean cascade, boolean skipCustomListeners, boolean skipIoMappings)
void	deleteProcessDefinitionsByKeyAndTenantId(java.lang.String processDefinitionKey, boolean cascade, boolean skipCustomListeners, boolean skipIoMappings, java.lang.String tenantId)
ProcessDefinitionResource	getProcessDefinitionById(java.lang.String processDefinitionId)
ProcessDefinitionResource	getProcessDefinitionByKey(java.lang.String processDefinitionKey)
ProcessDefinitionResource	getProcessDefinitionByKeyAndTenantId(java.lang.String processDefinitionKey, java.lang.String tenantId)
java.util.List<ProcessDefinitionDto>	getProcessDefinitions(javax.ws.rs.core.UriInfo uriInfo, java.lang.Integer firstResult, java.lang.Integer maxResults)	Exposes the ProcessDefinitionQuery interface as a REST service.
CountResultDto	getProcessDefinitionsCount(javax.ws.rs.core.UriInfo uriInfo)
java.util.List<StatisticsResultDto>	getStatistics(java.lang.Boolean includeFailedJobs, java.lang.Boolean includeRootIncidents, java.lang.Boolean includeIncidents, java.lang.String includeIncidentsForType)
void	updateSuspensionState(ProcessDefinitionSuspensionStateDto dto)

Field Detail

APPLICATION_BPMN20_XML

static final java.lang.String APPLICATION_BPMN20_XML

See Also:

Constant Field Values

APPLICATION_BPMN20_XML_TYPE

static final javax.ws.rs.core.MediaType APPLICATION_BPMN20_XML_TYPE

PATH

static final java.lang.String PATH

See Also:

Constant Field Values

Method Detail

getProcessDefinitionById

@Path("/{id}")
ProcessDefinitionResource getProcessDefinitionById(@PathParam("id")
                                                   java.lang.String processDefinitionId)

getProcessDefinitionByKey

@Path("/key/{key}")
ProcessDefinitionResource getProcessDefinitionByKey(@PathParam("key")
                                                    java.lang.String processDefinitionKey)

getProcessDefinitionByKeyAndTenantId

@Path("/key/{key}/tenant-id/{tenantId}")
ProcessDefinitionResource getProcessDefinitionByKeyAndTenantId(@PathParam("key")
                                                               java.lang.String processDefinitionKey,
                                                               @PathParam("tenantId")
                                                               java.lang.String tenantId)

getProcessDefinitions

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

Exposes the ProcessDefinitionQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

getProcessDefinitionsCount

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

getStatistics

@GET
@Path("/statistics")
@Produces("application/json")
java.util.List<StatisticsResultDto> getStatistics(@QueryParam("failedJobs")
                                                  java.lang.Boolean includeFailedJobs,
                                                  @QueryParam("rootIncidents")
                                                  java.lang.Boolean includeRootIncidents,
                                                  @QueryParam("incidents")
                                                  java.lang.Boolean includeIncidents,
                                                  @QueryParam("incidentsForType")
                                                  java.lang.String includeIncidentsForType)

updateSuspensionState

@PUT
@Path("/suspended")
@Consumes("application/json")
void updateSuspensionState(ProcessDefinitionSuspensionStateDto dto)

deleteProcessDefinitionsByKey

@DELETE
@Path("/key/{key}/delete")
void deleteProcessDefinitionsByKey(@PathParam("key")
                                   java.lang.String processDefinitionKey,
                                   @QueryParam("cascade")
                                   boolean cascade,
                                   @QueryParam("skipCustomListeners")
                                   boolean skipCustomListeners,
                                   @QueryParam("skipIoMappings")
                                   boolean skipIoMappings)

deleteProcessDefinitionsByKeyAndTenantId

@DELETE
@Path("/key/{key}/tenant-id/{tenantId}/delete")
void deleteProcessDefinitionsByKeyAndTenantId(@PathParam("key")
                                              java.lang.String processDefinitionKey,
                                              @QueryParam("cascade")
                                              boolean cascade,
                                              @QueryParam("skipCustomListeners")
                                              boolean skipCustomListeners,
                                              @QueryParam("skipIoMappings")
                                              boolean skipIoMappings,
                                              @PathParam("tenantId")
                                              java.lang.String tenantId)