org.bonitasoft.engine.api (Bonita BPM Engine 6.2 API)

Interface Summary
Interface	Description
APIAccessor	Gives access to some common APIs.
CommandAPI	Manipulate tenant commands.
DocumentAPI	Manipulate documents that are attached to a process instance.
GroupAPI	GroupAPI forms part of the `OrganizationAPI` and gives access to all the Administation operations available on Groups: creation, deletion, updating, search, etc...
IdentityAPI	The Interface IdentityAPI.
LoginAPI	The LoginAPI allows to log in (and out) onto the Engine.
MembershipAPI	MembershipAPI forms part of the `OrganizationAPI` and gives access to all the Administation operations available on `UserMembership`s: creation, deletion, updating, retrieval, etc...
OrganizationAPI	Manages the Organization, that is the users, groups, roles, memberships, through import / export methods.
PlatformAPI	Manage the platform.
PlatformCommandAPI	Manipulate tenant commands.
PlatformLoginAPI	Manage the login on the platform.
ProcessAPI	Contains all methods that handle processes.
ProcessManagementAPI	This API deals with definition objects such as `ProcessDefinition`, `ProcessDeploymentInfo`, `Category`, ...
ProcessRuntimeAPI	`ProcessRuntimeAPI` deals with Process runtime notions such as starting a new instance of a process, retrieving and executing tasks, accessing to all types of tasks, assigning a user to a task, retrieving archived versions of a task, accessing / updating data / variable values, adding / retrieving process comments ...
ProfileAPI	Profiles are a notion used in BonitaBPM Portal to give and control access to some specific features of the Bonita BPM suite.
RoleAPI	RoleAPI forms part of the `OrganizationAPI` and gives access to all the Administation operations available on Roles: creation, deletion, search, etc...
ThemeAPI	Manage mobile and portal theme.
UserAPI	UserAPI forms part of the `OrganizationAPI` and gives access to all the Administation operations available on Users: creation, deletion, certain specific getXXX() methods, generic search methods, etc...

Class Summary
Class Description

PlatformAPIAccessor
Accessor class that retrieve Platform APIs

TenantAPIAccessor
Accessor class that retrieve APIs in Bonita BPM Community Edition.
Enum Summary
Enum Description

ApiAccessType
Annotation Types Summary
Annotation Type Description

NoSessionRequired
Indicates that a Bonita API method does not need to have a valid session to be called.

Class Summary
Class	Description
PlatformAPIAccessor	Accessor class that retrieve Platform APIs
TenantAPIAccessor	Accessor class that retrieve APIs in Bonita BPM Community Edition.

Enum Summary
Enum	Description
ApiAccessType

Annotation Types Summary
Annotation Type	Description
NoSessionRequired	Indicates that a Bonita API method does not need to have a valid session to be called.

Package org.bonitasoft.engine.api Description

Main Community Edition package to access Community APIs. If you have a Subscription license, please use com.bonitasoft.engine.api package that gives full access to all Subscription features.
Please keep in mind that org.bonitasoft.engine.* packages are for Community and Subscription developers, and com.bonitasoft.engine.* packages are for Subscription developers only.
The Bonita BPM project has a clear separation between the API the users should be interacting with and the actual implementation classes.
The public API exposes most of the features we believe "normal" users can safely use and should remain rather stable across releases.
Expert users can still access internal classes but should be aware that they should know what they are doing and that the internal API might still change in the future.