Flowable Rest API Documentation

This project contains information and tooling about Flowable Public Rest API.

Introduction

Flowable includes a set of Public REST API to the Flowable Engine.

We distinct currently 4 groups of APIs

• Process API : Provides access to most of the Flowable services
• Decision API : Provides access to the Flowable DMN engine
• Form API : Provides access to the Flowable Form engine
• Content API : Provides access to the Flowable Content Services

Quick Installation

Flowable REST API can be installed by deploying the flowable-rest.war or flowable-task.war file to a servlet container like Apache Tomcat.

It’s also possible to use Docker images to easily boot up an environment.

docker run -p8080:8080 flowable/flowable-rest

Quick Integration

The Flowable REST API can also be used in another web-application by including the servlet and its mapping in your application and add all flowable-rest dependencies to the classpath.

Contribution & Documentation Issues

If you spot a documentation issue please raise an issue directly on Github or create a Pull Request

References

OpenAPI is a standard specification to describe a REST API. It’s vendor neutral and backed by the OpenAPI initiative which includes many software companies (Google, Microsoft, IBM, Atlassian…).

Swagger Specification V2

You can retrieve the Swagger Specification for Flowable API by following links below.

API Name	Syntax Validation
Process API
Form API
Decision API
Content API

Open API Specification V3

You can retrieve the OpenApi Specification (V3) for Flowable API by following links below.

Tools

To help developers discovering & using Flowable API, we provide a set of tools ready to use.

Flowable OpenAPI Specification Generator

Utility project to generate automatically the swagger definition from the source code.

Flowable Rest Asciidoc

Utility project to generate asciidoc based on OAS files.

Flowable Swagger UI

Utility project to build a WAR file for Swagger UI.

Flowable Slate

Utility project to create a beautiful static web site for REST API docs.

Flowable Swagger Codegen

Utility project to generate client sdk to interact with Flowable Rest API.