Overview (Bonita Engine 7.9 API)

Packages
Package	Description
com.bonitasoft.engine.api	The Bonita project has a clear separation between the API the users should be interacting with and the actual implementation classes.
com.bonitasoft.engine.api.converter
com.bonitasoft.engine.api.impl
com.bonitasoft.engine.bdm
com.bonitasoft.engine.bdm.accesscontrol
com.bonitasoft.engine.bdm.accesscontrol.builder
com.bonitasoft.engine.bdm.accesscontrol.model
com.bonitasoft.engine.bdm.dao
com.bonitasoft.engine.bpm.bar
com.bonitasoft.engine.bpm.flownode
com.bonitasoft.engine.bpm.parameter
com.bonitasoft.engine.bpm.parameter.impl
com.bonitasoft.engine.bpm.process	Package com.bonitasoft.engine.bpm.process gathers all model interfaces and exceptions related to process instance / definition objects manipulated by process APIs, and specific to Bonita Subscription Edition.
com.bonitasoft.engine.bpm.process.impl
com.bonitasoft.engine.business.application
com.bonitasoft.engine.business.data
com.bonitasoft.engine.businessdata
com.bonitasoft.engine.businessdata.impl
com.bonitasoft.engine.connector
com.bonitasoft.engine.converter
com.bonitasoft.engine.exception
com.bonitasoft.engine.log	Provides classes and interfaces for business data (BD) and repository (BDR).
com.bonitasoft.engine.log.impl
com.bonitasoft.engine.monitoring
com.bonitasoft.engine.monitoring.impl
com.bonitasoft.engine.platform	Contains classes and interfaces related to the `Bonita Platform`.
com.bonitasoft.engine.platform.impl
com.bonitasoft.engine.profile
com.bonitasoft.engine.reporting
com.bonitasoft.engine.reporting.impl
com.bonitasoft.engine.theme
com.bonitasoft.engine.theme.exception
org.bonitasoft.engine
org.bonitasoft.engine.api	The Bonita project has a clear separation between the API the users should be interacting with and the actual implementation classes.
org.bonitasoft.engine.api.impl
org.bonitasoft.engine.api.internal	contains `ServerAPI` interface
org.bonitasoft.engine.api.permission
org.bonitasoft.engine.api.result
org.bonitasoft.engine.api.tcp
org.bonitasoft.engine.bar
org.bonitasoft.engine.bdm	Provides classes and interfaces for business data models (BDM).
org.bonitasoft.engine.bdm.dao
org.bonitasoft.engine.bdm.lazy
org.bonitasoft.engine.bdm.model
org.bonitasoft.engine.bdm.model.field
org.bonitasoft.engine.bdm.serialization
org.bonitasoft.engine.bdm.validator
org.bonitasoft.engine.bdm.validator.rule
org.bonitasoft.engine.bdm.validator.rule.composition
org.bonitasoft.engine.bpm	Provides classes and interfaces for BPM basic concepts
org.bonitasoft.engine.bpm.actor	This package contains everything concerning Actor : Definition, Instance, Exceptions, Updater...
org.bonitasoft.engine.bpm.actor.impl	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.bar	Contains classes and interfaces related to the Java representation of a `business archive` (*.bar)
org.bonitasoft.engine.bpm.bar.actorMapping	Contains Actor mapping model classes.
org.bonitasoft.engine.bpm.bar.form.model
org.bonitasoft.engine.bpm.businessdata
org.bonitasoft.engine.bpm.businessdata.impl	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.category	This package contains everything concerning Category : Criterion, Exceptions, Updater...
org.bonitasoft.engine.bpm.category.impl
org.bonitasoft.engine.bpm.comment	This package contains everything concerning Comment : Archived, Search descriptor...
org.bonitasoft.engine.bpm.comment.impl
org.bonitasoft.engine.bpm.connector	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.connector.impl	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.context	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.contract	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.contract.impl	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.data	This package contains everything concerning Data : Definition, Instance, Exceptions, Criterion...
org.bonitasoft.engine.bpm.data.impl	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.document
org.bonitasoft.engine.bpm.document.impl	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.flownode	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.flownode.impl
org.bonitasoft.engine.bpm.flownode.impl.internal	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.form
org.bonitasoft.engine.bpm.internal	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.parameter
org.bonitasoft.engine.bpm.parameter.impl	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.process	Package org.bonitasoft.engine.bpm.process gathers all model interfaces and exceptions related to process instance / definition objects manipulated by process APIs.
org.bonitasoft.engine.bpm.process.impl
org.bonitasoft.engine.bpm.process.impl.internal	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.bpm.supervisor
org.bonitasoft.engine.bpm.supervisor.impl
org.bonitasoft.engine.bpm.userfilter
org.bonitasoft.engine.bpm.userfilter.impl	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.business.application
org.bonitasoft.engine.business.application.exporter
org.bonitasoft.engine.business.application.impl
org.bonitasoft.engine.business.application.xml
org.bonitasoft.engine.business.data
org.bonitasoft.engine.business.data.impl
org.bonitasoft.engine.command
org.bonitasoft.engine.connector
org.bonitasoft.engine.entitymember
org.bonitasoft.engine.entitymember.impl
org.bonitasoft.engine.exception
org.bonitasoft.engine.expression
org.bonitasoft.engine.expression.impl	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.filter
org.bonitasoft.engine.form
org.bonitasoft.engine.home	Contains classes related to the `Bonita Home`.
org.bonitasoft.engine.identity	Manages information about an organization, that is, the set of users who can act in processes and the groups and the organization's roles and the relation between them.
org.bonitasoft.engine.identity.impl
org.bonitasoft.engine.io
org.bonitasoft.engine.job
org.bonitasoft.engine.job.impl
org.bonitasoft.engine.operation	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.operation.impl	Copyright (C) 2015 BonitaSoft S.A.
org.bonitasoft.engine.page
org.bonitasoft.engine.page.impl
org.bonitasoft.engine.platform	Contains classes and interfaces related to the `Bonita Platform`.
org.bonitasoft.engine.platform.command	Contains classes related to `Platform commands`.
org.bonitasoft.engine.platform.command.impl
org.bonitasoft.engine.platform.impl
org.bonitasoft.engine.profile
org.bonitasoft.engine.profile.impl
org.bonitasoft.engine.profile.xml
org.bonitasoft.engine.search	Contains classes to use when invoking search methods
org.bonitasoft.engine.search.impl
org.bonitasoft.engine.session
org.bonitasoft.engine.session.impl
org.bonitasoft.engine.tenant
org.bonitasoft.engine.theme
org.bonitasoft.engine.theme.exception
org.bonitasoft.engine.theme.impl
org.bonitasoft.engine.util
org.bonitasoft.engine.xml
org.bonitasoft.engine.xml.parser

This is an overview of Bonita Engine API.

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

The main classes to start with are:

APIClient that gives access to APIs for Subscription users
APIClient that gives access to APIs for Community users

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

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

import org.bonitasoft.engine.api.APIClient;

// First of all, create a new APIClient:
APIClient apiClient = new APIClient();
// Then, simply log in:
apiClient.login(userName, password);

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

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

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

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