Package org.camunda.bpm.engine.rest.sub.repository

Interface ProcessDefinitionResource

All Known Implementing Classes:

ProcessDefinitionResourceImpl

public interface ProcessDefinitionResource

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	deleteProcessDefinition(boolean cascade, boolean skipCustomListeners, boolean skipIoMappings)
java.util.List<StatisticsResultDto>	getActivityStatistics(java.lang.Boolean includeFailedJobs, java.lang.Boolean includeIncidents, java.lang.String includeIncidentsForType)
javax.ws.rs.core.Response	getDeployedStartForm()
java.util.Map<java.lang.String,VariableValueDto>	getFormVariables(java.lang.String variableNames, boolean deserializeValues)
ProcessDefinitionDto	getProcessDefinition()
ProcessDefinitionDiagramDto	getProcessDefinitionBpmn20Xml()
javax.ws.rs.core.Response	getProcessDefinitionDiagram()
javax.ws.rs.core.Response	getRenderedForm()
FormDto	getStartForm()
java.util.List<CalledProcessDefinitionDto>	getStaticCalledProcessDefinitions()
void	restartProcessInstance(RestartProcessInstanceDto restartProcessInstanceDto)
BatchDto	restartProcessInstanceAsync(RestartProcessInstanceDto restartProcessInstanceDto)
ProcessInstanceDto	startProcessInstance(javax.ws.rs.core.UriInfo context, StartProcessInstanceDto parameters)
ProcessInstanceDto	submitForm(javax.ws.rs.core.UriInfo context, StartProcessInstanceDto parameters)
void	updateHistoryTimeToLive(HistoryTimeToLiveDto historyTimeToLiveDto)
void	updateSuspensionState(ProcessDefinitionSuspensionStateDto dto)

Method Detail

getProcessDefinition

@GET
@Produces("application/json")
ProcessDefinitionDto getProcessDefinition()

getProcessDefinitionBpmn20Xml

@GET
@Path("/xml")
@Produces("application/json")
ProcessDefinitionDiagramDto getProcessDefinitionBpmn20Xml()

getProcessDefinitionDiagram

@GET
@Path("/diagram")
javax.ws.rs.core.Response getProcessDefinitionDiagram()

deleteProcessDefinition

@DELETE
javax.ws.rs.core.Response deleteProcessDefinition(@QueryParam("cascade")
                                                  boolean cascade,
                                                  @QueryParam("skipCustomListeners")
                                                  boolean skipCustomListeners,
                                                  @QueryParam("skipIoMappings")
                                                  boolean skipIoMappings)

startProcessInstance

@POST
@Path("/start")
@Consumes("application/json")
@Produces("application/json")
ProcessInstanceDto startProcessInstance(@Context
                                        javax.ws.rs.core.UriInfo context,
                                        StartProcessInstanceDto parameters)

restartProcessInstance

@POST
@Path("/restart")
@Consumes("application/json")
void restartProcessInstance(RestartProcessInstanceDto restartProcessInstanceDto)

restartProcessInstanceAsync

@POST
@Path("/restart-async")
@Consumes("application/json")
@Produces("application/json")
BatchDto restartProcessInstanceAsync(RestartProcessInstanceDto restartProcessInstanceDto)

submitForm

@POST
@Path("/submit-form")
@Consumes("application/json")
@Produces("application/json")
ProcessInstanceDto submitForm(@Context
                              javax.ws.rs.core.UriInfo context,
                              StartProcessInstanceDto parameters)

getActivityStatistics

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

getStartForm

@GET
@Path("/startForm")
@Produces("application/json")
FormDto getStartForm()

getDeployedStartForm

@GET
@Path("/deployed-start-form")
javax.ws.rs.core.Response getDeployedStartForm()

getRenderedForm

@GET
@Path("/rendered-form")
@Produces("application/xhtml+xml")
javax.ws.rs.core.Response getRenderedForm()

updateSuspensionState

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

updateHistoryTimeToLive

@PUT
@Path("/history-time-to-live")
@Consumes("application/json")
void updateHistoryTimeToLive(HistoryTimeToLiveDto historyTimeToLiveDto)

getFormVariables

@GET
@Path("/form-variables")
@Produces("application/json")
java.util.Map<java.lang.String,VariableValueDto> getFormVariables(@QueryParam("variableNames")
                                                                        java.lang.String variableNames,
                                                                        @QueryParam("deserializeValues") @DefaultValue("true")
                                                                        boolean deserializeValues)

getStaticCalledProcessDefinitions

@GET
@Path("/static-called-process-definitions")
@Produces("application/json")
java.util.List<CalledProcessDefinitionDto> getStaticCalledProcessDefinitions()