How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bonitasoft Process API

Deploy and manage process definitions. In addition, you can instantiate a process, which will create a new process instance (case).

Bonitasoft Process API is one of 76 APIs that Bonitasoft publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Processes. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 12 operations across 8 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 1.0.9.

Requests are made against a single base URL, http://localhost:8080/bonita.

12 operations 8 paths 20 schemas 2 DELETE5 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.9
Base URL
https://{subscription}.bonitacloud.com/bonita
Authentication
API Key, API Key, HTTP Bearer
License
Resource Areas
1

Authentication & Security 3

Bonitasoft Process API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as JSESSIONID (bonita_auth). An API key is passed in the header as X-Bonita-API-Token (bonita_token). It accepts HTTP bearer tokens (bearer_auth). By default, every request must be authenticated.

  • bonita_auth — To call the REST API, you must first log on with a user registered in the Engine database. Please refer to the [Login API](operation/login) operations section.
  • bonita_token — To call the REST API, you must first log on with a user registered in the Engine database. Please refer to the [Login API](operation/login) operations section.
  • bearer_auth — ![edition](https://img.shields.io/badge/edition-entreprise-blue) When Bonita runtime is configured for SSO with openID Connect it is possible To call the REST…

Paths & Operations 12

Across 8 paths, the API surfaces 12 operations — 2 DELETE, 5 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Process 12

Deploy and manage process definitions. In addition, you can instantiate a process, which will create a new process instance (case).

GET
/API/bpm/process
Finds Processes
searchProcesses 5 params → 2004004014035XX
POST
/API/bpm/processdeprecated
Create the Process
createProcess body → 2004004014035XX
DELETE
/API/bpm/process
Delete the Process by IDs
deleteProcessByIds body → 2004004014035XX
GET
/API/bpm/process/{id}
Finds the Process by ID
getProcessById 1 param → 2004004014034045XX
PUT
/API/bpm/process/{id}deprecated
Update the Process by ID
updateProcessById 1 param body → 2004004014034045XX
DELETE
/API/bpm/process/{id}
Delete the Process by ID
deleteProcessById 1 param → 2004004014034045XX
GET
/API/bpm/process/{id}/design
Finds the Process design by ID
getProcessDesignById 1 param → 2004004014034045XX
GET
/API/bpm/process/{id}/contract
Finds the Process contract by ID
getProcessContractById 1 param → 2004004014034045XX
POST
/API/bpm/process/{id}/instantiation
Instanciate the process
instanciateProcess 1 param body → 2014004014034295XX
GET
/API/bpm/processName
Search process names
searchProcessNames 5 params → 2004004014035XX
PUT
/API/bpm/processConnector/{id}/{connectorImplId}/{connectorImplVersion}deprecated
Update the Process Connector by Process ID
updateProcessConnectorByProcessId 3 params body → 2004004014045XX
POST
/portal/processUploaddeprecated
Upload a bar file
uploadProcess body → 2004004014035XX

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ProcessDefinition (13 properties), FlowElementContainerDefinition (12 properties), DesignProcessDefinition (10 properties), Expression (7 properties). Each schema is shown below with its type and property counts.

ContractConstraint
object
4 properties
ProcessDefinition
object
13 properties
ContractInput
object
5 properties
ContractInputType
string
the contract input type (string)
ProcessName
object
A group of deployed processes that share the same (name, displayName) pair, with the list of their deployed versions. Returned by GET /API/bpm/processName, whi…
3 properties 3 required
ActivationState
string
the state of the process definition (ENABLED or DISABLED)
ProcessUpdateRequest
object
3 properties
UpdateProcessConnectorByProcessIdRequest
object
2 properties
ConfigurationState
string
the configuration state of the process (UNRESOLVED or RESOLVED)
FlowElementContainerDefinition
object
Allows to access all flow elements (activities, gateways, events and transitions) of a process or sub-process.
12 properties
ProcessCreateRequest
object
1 property
Expression
object
7 properties
DesignProcessDefinitionContext
object
The process definition expressions
2 properties
DesignProcessDefinition
object
Represents the Design Definition of a process. It gives access to process attributes.
10 properties
Contract
object
2 properties
ActorDefinition
object
Actor definition
3 properties
ProcessInstantiationResponse
object
1 property
FileUploadRequest
object
The file to upload
1 property
DesignProcessDefinitionParamater
object
3 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bonitasoft-process-api-openapi.yml Raw ↑

Other APIs Bonitasoft publishes across the network.

Bonitasoft Activity API
Bonitasoft Activity Variable API
Bonitasoft Actor API
Bonitasoft Actor Member API
Bonitasoft Application API
Bonitasoft Application Menu API
Bonitasoft Application Page API
Bonitasoft Archived Activity API
Bonitasoft Archived Activity Variable API
Bonitasoft Archived Connector Instance API
Bonitasoft Archived Failure API
Bonitasoft Archived Flow Node API
Where this information came from

This is an independent, third-party profile of Bonitasoft Process API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.