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
jakarta.ws.rs.core.Response	deleteProcessDefinition(boolean cascade, boolean skipCustomListeners, boolean skipIoMappings)
List<StatisticsResultDto>	getActivityStatistics(Boolean includeFailedJobs, Boolean includeIncidents, String includeIncidentsForType)
jakarta.ws.rs.core.Response	getDeployedStartForm()
Map<String,VariableValueDto>	getFormVariables(String variableNames, boolean deserializeValues)
ProcessDefinitionDto	getProcessDefinition()
ProcessDefinitionDiagramDto	getProcessDefinitionBpmn20Xml()
jakarta.ws.rs.core.Response	getProcessDefinitionDiagram()
jakarta.ws.rs.core.Response	getRenderedForm()
FormDto	getStartForm()
List<CalledProcessDefinitionDto>	getStaticCalledProcessDefinitions()
void	restartProcessInstance(RestartProcessInstanceDto restartProcessInstanceDto)
BatchDto	restartProcessInstanceAsync(RestartProcessInstanceDto restartProcessInstanceDto)
ProcessInstanceDto	startProcessInstance(jakarta.ws.rs.core.UriInfo context, StartProcessInstanceDto parameters)
ProcessInstanceDto	submitForm(jakarta.ws.rs.core.UriInfo context, StartProcessInstanceDto parameters)
void	updateHistoryTimeToLive(HistoryTimeToLiveDto historyTimeToLiveDto)
void	updateSuspensionState(ProcessDefinitionSuspensionStateDto dto)

Method Details

getProcessDefinition

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

getProcessDefinitionBpmn20Xml

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

getProcessDefinitionDiagram

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

deleteProcessDefinition

@DELETE
jakarta.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
 jakarta.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
 jakarta.ws.rs.core.UriInfo context,
 StartProcessInstanceDto parameters)

getActivityStatistics

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

getStartForm

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

getDeployedStartForm

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

getRenderedForm

@GET
@Path("/rendered-form")
@Produces("application/xhtml+xml")
jakarta.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")
Map<String,VariableValueDto> getFormVariables(@QueryParam("variableNames")
 String variableNames,
 @QueryParam("deserializeValues") @DefaultValue("true")
 boolean deserializeValues)

getStaticCalledProcessDefinitions

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