This documentation is for a version that is out of support.

You may want to view the same page for the latest version, or for any of the versions available in the drop-down menu in the top-right corner.

Bonita API

Bonita provides REST and Java API’s to interact with the Runtime. Learn how to use them here.

REST API

The basics

REST API overview Learn how to use the REST API

REST API glossary A few things to know to best use the REST API

REST Authentication Authentication is a prerequisite to any other REST API call

REST API extensions overview Introduction and example

Create a REST API extension Tools to develop and test your REST API Extensions

Per theme

Application API Retrieve the current deployed application definitions

BDM Access Control API Retrieve BDM Access Control status

BDM API Query the Business data

BPM API Retrieve activities, perform maintenance tasks

Custom User Information API Manage your specific user information

Form API Map a form to a process or a task

Identity API Manage the organization

Platform API Manage Bonita platform-level resources

Portal API Access and manage pages, profiles and themes

System API Retrieve information on the current session and on localisation / translation.

Tenant API Show the tenant status or install / update the BDM

Java API

The basics

Overview View the high-level list and usage of Java API

Javadoc Complete Javadoc of the Java API

Common use-cases

Managing a process Manage processes through Java API

Handling a failed activity Create process error recovery through Java API

Managing an organization Manage people involved in the process execution through Java API

Managing users Manage the users of your organization through Java API

Handling documents Handle documents within processes through Java API

Managing the platform Manage the platform through Java API

Specific use cases with API

Manage BDM in REST API extensions Manage your Business data in your REST API extensions

Manage files using upload servlet and REST API Manage files through REST API

Create administration tools Create your own tools to administrate the platform through Java API

List and search methods Learn about the options of Bonita lists and Bonita search methods

Queriable logger Access all events logged in Bonita Runtime through Java API