Skip to main content

REST API

To enable the REST API you can use the following starter in your pom.xml:

<dependency>
<groupId>org.operaton.bpm.springboot</groupId>
<artifactId>operaton-bpm-spring-boot-starter-rest</artifactId>
<version>{project-version}</version>
</dependency>

By default the application path is engine-rest, so without any further configuration you can access the api at http://localhost:8080/engine-rest.

Because we use jersey, one can use spring boot's common application properties. For example, to change the application path, use

spring.jersey.application-path=myapplicationpath

To modify the configuration or register additional resources, one can provide a bean which extends from org.operaton.bpm.spring.boot.starter.rest.OperatonJerseyResourceConfig:

@Component
@ApplicationPath("/engine-rest")
public class JerseyConfig extends OperatonJerseyResourceConfig {

@Override
protected void registerAdditionalResources() {
register(...);
}

}