Bonitasoft Data Retention API
Configure how Bonita automatically deletes obsolete business data. A retention rule applies to a specific business object type and defines when its instances become eligible for deletion based on a reference date (creation or last update) and a retention period in days. The data retention service runs on a configurable cron schedule.This Web REST API is available in **Enterprise editions only**, since version 11.0.
Bonitasoft Data Retention API is one of 76 APIs that Bonitasoft publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Data Retention. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.
This API exposes 5 operations across 4 paths, and defines 8 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Bonitasoft Data Retention 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—  When Bonita runtime is configured for SSO with openID Connect it is possible To call the REST…
Paths & Operations 5
Across 4 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Configure how Bonita automatically deletes obsolete business data. A retention rule applies to a specific business object type and defines when its instances become eligible for d…
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are DataRetentionConfig (6 properties), RetentionRuleCreateRequest (3 properties), BusinessObjectWithRetentionRule (3 properties), Error (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Bonitasoft 12
Other APIs Bonitasoft publishes across the network.
This is an independent, third-party profile of Bonitasoft Data Retention 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.