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 final String	APPLICATION_BPMN20_XML
static final jakarta.ws.rs.core.MediaType	APPLICATION_BPMN20_XML_TYPE
static final String	PATH

Method Summary

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

Field Details

APPLICATION_BPMN20_XML

static final String APPLICATION_BPMN20_XML

See Also:

• Constant Field Values

APPLICATION_BPMN20_XML_TYPE

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

PATH

static final String PATH

See Also:

• Constant Field Values

Method Details

getProcessDefinitionById

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

getProcessDefinitionByKey

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

getProcessDefinitionByKeyAndTenantId

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

getProcessDefinitions

@GET
@Produces("application/json")
List<ProcessDefinitionDto> getProcessDefinitions(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @QueryParam("firstResult")
 Integer firstResult,
 @QueryParam("maxResults")
 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
 jakarta.ws.rs.core.UriInfo uriInfo)

getStatistics

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

updateSuspensionState

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

deleteProcessDefinitionsByKey

@DELETE
@Path("/key/{key}/delete")
void deleteProcessDefinitionsByKey(@PathParam("key")
 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")
 String processDefinitionKey,
 @QueryParam("cascade")
 boolean cascade,
 @QueryParam("skipCustomListeners")
 boolean skipCustomListeners,
 @QueryParam("skipIoMappings")
 boolean skipIoMappings,
 @PathParam("tenantId")
 String tenantId)