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

Interface ProcessDefinitionResource

All Known Implementing Classes:

ProcessDefinitionResourceImpl

public interface ProcessDefinitionResource

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteProcessDefinition(boolean cascade, boolean skipCustomListeners, boolean skipIoMappings)
List<StatisticsResultDto>	getActivityStatistics(Boolean includeFailedJobs, Boolean includeIncidents, String includeIncidentsForType)
javax.ws.rs.core.Response	getDeployedStartForm()
Map<String,VariableValueDto>	getFormVariables(String variableNames, boolean deserializeValues)
ProcessDefinitionDto	getProcessDefinition()
ProcessDefinitionDiagramDto	getProcessDefinitionBpmn20Xml()
javax.ws.rs.core.Response	getProcessDefinitionDiagram()
javax.ws.rs.core.Response	getRenderedForm()
FormDto	getStartForm()
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(value="application/json")
ProcessDefinitionDto getProcessDefinition()

getProcessDefinitionBpmn20Xml

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

getProcessDefinitionDiagram

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

deleteProcessDefinition

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

startProcessInstance

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

restartProcessInstance

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

restartProcessInstanceAsync

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

submitForm

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

getActivityStatistics

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

getStartForm

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

getDeployedStartForm

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

getRenderedForm

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

updateSuspensionState

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

updateHistoryTimeToLive

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

getFormVariables

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