org.camunda.bpm.engine.rest
Interface ProcessDefinitionRestService

All Known Implementing Classes:

ProcessDefinitionRestServiceImpl

public interface ProcessDefinitionRestService

Field Summary

static String	APPLICATION_BPMN20_XML
static javax.ws.rs.core.MediaType	APPLICATION_BPMN20_XML_TYPE
static String	PATH

Method Summary

ProcessDefinitionResource	getProcessDefinitionById(String processDefinitionId)
ProcessDefinitionResource	getProcessDefinitionByKey(String processDefinitionKey)
ProcessDefinitionResource	getProcessDefinitionByKeyAndTenantId(String processDefinitionKey, String tenantId)
List<ProcessDefinitionDto>	getProcessDefinitions(javax.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults) Exposes the ProcessDefinitionQuery interface as a REST service.
CountResultDto	getProcessDefinitionsCount(javax.ws.rs.core.UriInfo uriInfo)
List<StatisticsResultDto>	getStatistics(Boolean includeFailedJobs, Boolean includeIncidents, String includeIncidentsForType)
void	updateSuspensionState(ProcessDefinitionSuspensionStateDto dto)

Field Detail

APPLICATION_BPMN20_XML

static final 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 String PATH

See Also:

Constant Field Values

Method Detail

getProcessDefinitionById

ProcessDefinitionResource getProcessDefinitionById(String processDefinitionId)

getProcessDefinitionByKey

ProcessDefinitionResource getProcessDefinitionByKey(String processDefinitionKey)

getProcessDefinitionByKeyAndTenantId

ProcessDefinitionResource getProcessDefinitionByKeyAndTenantId(String processDefinitionKey,
                                                               String tenantId)

getProcessDefinitions

List<ProcessDefinitionDto> getProcessDefinitions(@Context
                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                 Integer firstResult,
                                                 Integer maxResults)

Exposes the ProcessDefinitionQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

getProcessDefinitionsCount

CountResultDto getProcessDefinitionsCount(@Context
                                          javax.ws.rs.core.UriInfo uriInfo)

getStatistics

List<StatisticsResultDto> getStatistics(Boolean includeFailedJobs,
                                        Boolean includeIncidents,
                                        String includeIncidentsForType)

updateSuspensionState

void updateSuspensionState(ProcessDefinitionSuspensionStateDto dto)