This documentation (Bonita Open Solution V5) is an archive. Please click here for current documentation.
Advanced search

List of APIs

Open Source

This page introduces the available APIs.

For details, see the Bonita Runtime APIs Javadoc.

Note: It is obligatory to use the AccessorUtil (org.ow2.bonita.util.AccessorUtil) utility class to access to all available APIs.

(See here for more information about the REST API.)

ManagementAPI

The Management API is responsible for managing the definition of processes. The Management API is also responsible for defining access control lists.

You would use the Management API for example to:

  • Deploy a process
  • Define which user can start a process
  • Hide a process from the user Panel

QueryDefinitionAPI

The query definition API isused mainly to access read only process definitions.

You may use the query definition API to:

  • List all the processes deployed on the server
  • Get all the task definitions of a process

This interface could be seen as complementary to ManagementAPI interface.

RuntimeAPI

The runtime API is used to manage instances of running processes. Using this interface, you can for example:

  • Start a process
  • Validate a task
  • Change the value of a process variable

QueryRuntimeAPI


The query runtime API is used to get information on instances of running processes. Using this interface, you can for example:

  • Get running instances
  • Get tasks affected to a user
  • Get the value of a process variable

IdentityAPI

The identity API is used to manage the bonita user directory. Using this API, you can for example:

  • Create a new user
  • Add a role and a group to a user
  • Check user credentials

BAMAPI

The BAM API calls key performance indicators about the execution of processes. Using this API, you can for example:

  • Get the execution time of a task
  • Get the time needed for an instance to finish

CommandAPI

The command API is used to inject some code into the engine. By using this interface, you have full access to all objects used by the engine and may be used to add features.

WebAPI

This API ised for internal use of the Bonita User Experience only. You should never use it.