This documentation is about a version that is out of support, here is the latest documentation version.

How about downloading a newer, supported version?

REST API Extensions

Extend REST Resources using Bonita, to send information on a form. REST API Extensions are manage as resources.

If you want to learn how to create REST API Extensions, refer to the documentation page about Bonita Studio tooling for creating and testing REST API Extensions (for Bonita subscription edition).

Page below contains information about deploying a REST API manually, which is possible with all editions.

Deploy a REST API Extension

You need to deploy the REST API Extensions zip archive using Bonita Portal:

  1. Connect to the Bonita Portal and switch to "administrator" view.

  2. Go to Resources. You will see the list of all resources, and a filter for each type of resource (Pages, Forms, Layouts, Themes and REST API Extensions).

  3. Click Add button (top left).

  4. Click in the Archive field, then select the REST API Extensions zip file.

  5. Click Next.

  6. Click Confirm. The resource is added to the portal

REST API Extensions use the same authorization mechanism as the standard Bonita REST APIs. When you import the extension, the information in is used to create the appropriate resource permission mappings in Bonita (see REST API authorization for information about REST API security configuration).

It is also possible to deploy a REST API Extensions using REST portal API / "page" resource.

The deployment of the REST API Extensions should always be made from the portal or its APIs, not directly from Engine APIs. Notably, the createPage() method of the Engine PageAPI would allow you to deploy a REST API Extensions, but would not update the security settings, meaning that you would not be able to access it at runtime.

If you are running Bonita in a cluster, after you import a REST API Extensions, you must restart the application server on all the cluster nodes.

As the deployment of the REST API Extensions automatically creates the appropriate resource permission mapping, be careful not to push a configuration that does not contain the latest permissions updates. This would overwrite the deployed configuration. To avoid doing so, pull the latest configuration, edit the needed elements and push it back to the Bonita runtime in a pretty short amount of time.


A REST API Extensions must be deployed before any page or form resource using it is deployed.

A page that uses REST API Extensions must add the required resources in the page resource file. For example, if a page uses the demoHeaders, demoXml, and putResource API extensions, its must include this line:


If the page declares its resources correctly, then every user being able to access this page (because it is part of a custom profile or Living Application they have access to) will also be automatically granted the necessary permissions to call the REST API Extensions. This works the same way as with the other resources of the REST API.
However, if you need to grant access to this REST API Extensions to some users regardless of the pages they have access to, then you need to add custom permissions for these users.
In order to do so, edit to give the permissions (value of the property apiExtension.permissions) declared in the of the REST API Extensions to the required profiles or users.

REST API permissions are stored in the user’s session and new permissions will only be effective for a user the next time he logs in to the portal.

In Bonita Studio, the debug mode is disabled by default. In debug mode, you can see changes on your REST API Extensions without importing a new zip archive, but it means the classloader of the extension is recreated at each request.
If you want to enable the debug mode, you can activate it in the Studio server preferences.

REST API Extensions examples

A REST API Extensions example resource and API extension viewer page are provided in administrator portal. They are located in administrator portal.

To use the examples, define a custom permissions mapping for demoPermission:

In a Tomcat bundle:

  • Retrieve platform configuration using the setup tool.

  • Edit platform_conf/current/tenants/<TENANT_ID>/tenant_portal/

  • Add the following line: profile|User=[demoPermission].

  • Push the changed platform configuration into database using the setup tool.

  • Restart Tomcat bundle

In Bonita Studio:

  • Open the from Development menu > REST API Extensions > Edit permission mapping

  • Add the following line: profile|User=[demoPermission]

  • Save the file

  • Logout from the current session and log back in

REST API Extensions examples show how to:

  • Customize response with additional header, cookie and response code

  • Get resource return a simple echo of query parameters

  • Use a SLF4J logger

  • Post resources with Json payload and return a simple echo of parameters

  • Return an XML content with specific media type and character set

  • Call to external SOAP webservice (requires internet connexion)

Another REST API Extensions example with SQL data source is available on Bonitasoft Community. This example show how to execute SQL queries on a external database.