Bonita BPM Engine 6.2 API

This is an overview of Bonita BPM Engine API.

See: Description

Packages 
Package Description
com.bonitasoft.engine.api
Main Subscription Edition package to access Subscription APIs.
com.bonitasoft.engine.bpm.breakpoint
com.bonitasoft.engine.bpm.flownode
com.bonitasoft.engine.bpm.parameter
com.bonitasoft.engine.bpm.process
com.bonitasoft.engine.bpm.process.impl
com.bonitasoft.engine.log
com.bonitasoft.engine.monitoring
com.bonitasoft.engine.platform
com.bonitasoft.engine.profile
com.bonitasoft.engine.reporting
com.bonitasoft.engine.theme
com.bonitasoft.engine.theme.exception
org.bonitasoft.engine.api
Main Community Edition package to access Community APIs.
org.bonitasoft.engine.api.internal
org.bonitasoft.engine.bpm  
org.bonitasoft.engine.bpm.actor
This package contains everything concerning Actor : Definition, Instance, Exceptions, Updater...
org.bonitasoft.engine.bpm.bar
org.bonitasoft.engine.bpm.category
This package contains everything concerning Category : Criterion, Exceptions, Updater...
org.bonitasoft.engine.bpm.comment
This package contains everything concerning Comment : Archived, Search descriptor...
org.bonitasoft.engine.bpm.connector
org.bonitasoft.engine.bpm.data
org.bonitasoft.engine.bpm.document
org.bonitasoft.engine.bpm.flownode
org.bonitasoft.engine.bpm.flownode.impl
org.bonitasoft.engine.bpm.parameter
org.bonitasoft.engine.bpm.process
org.bonitasoft.engine.bpm.supervisor
org.bonitasoft.engine.bpm.userfilter
org.bonitasoft.engine.command
org.bonitasoft.engine.connector  
org.bonitasoft.engine.entitymember
org.bonitasoft.engine.exception
org.bonitasoft.engine.expression
org.bonitasoft.engine.expression.impl
org.bonitasoft.engine.filter
org.bonitasoft.engine.home
org.bonitasoft.engine.identity
org.bonitasoft.engine.job
org.bonitasoft.engine.operation
org.bonitasoft.engine.operation.impl
org.bonitasoft.engine.platform
org.bonitasoft.engine.platform.command
org.bonitasoft.engine.profile
org.bonitasoft.engine.search
org.bonitasoft.engine.search.impl
org.bonitasoft.engine.session
org.bonitasoft.engine.theme
org.bonitasoft.engine.theme.exception
org.bonitasoft.engine.util

This is an overview of Bonita BPM Engine API.

Packages in org.bonitasoft.engine are available from Bonita BPM Community Edition, and also in Bonita BPM Subscription Editions
However, packages in com.bonitasoft.engine are only available for Bonita BPM Subscription Edition developers.

The main classes to start with are:

A good starting point on using Bonita BPM Engine APIs is Bonita documentation website

Here is a simple example of an Engine API (here, the IdentityAPI): 

// First of all, log in:
final LoginAPI loginAPI = TenantAPIAccessor.getLoginAPI();
APISession session = loginAPI.login(userName, password);

// Then access any Bonita BPM Engine API:
IdentityAPI identityAPI = TenantAPIAccessor.getIdentityAPI(session);

// For instance, get the current logged in user (yourself):
User myself = identityAPI.getUser(session.getUserId());

// ... do something with the User ...

// don't forget to log out:
loginAPI.logout(session);

Copyright © 2014 Bonitasoft S.A.. All Rights Reserved.