openapi: 3.2.0
info:
license:
name: GPL-v2.0
url: http://www.gnu.org/licenses/gpl-2.0.txt
version: 1.0.9
title: Bonita Application API
description: "
\nDownload OpenAPI specification\nDownload Postman collection\n
\n\n
\n\nThe REST API lets you access the data with HTTP requests; it is useful when implementing rich web forms / pages for a good user experience.\n\nAn open source [java client](https://github.com/bonitasoft/bonita-java-client) is implemented above the HTTP API. It is available on [Maven central](https://search.maven.org/search?q=g:%22org.bonitasoft.web%22%20AND%20a:%22bonita-java-client%22).\n\nIf your application is using a technology other than Java, you can integrate it with the Bonita solution using the Web REST API. This API provides\naccess to all Bonita objects (like processes, tasks, users, connectors etc.), to execute operations on them (create, retrieve, update, delete).\nYou can use these operations to create a workflow with Bonita and integrate it into your application. The Bonita Engine remains responsible for executing\nthe workflow logic (connectors, gateways with conditions, messages, timers etc.) while your application gives access to the workflow.\nUsers can manage processes and tasks, and perform administrative activities.\n\n### API Extensions\n\nYou can create [Rest API Extensions](https://documentation.ofelia.com/bonita/latest/api/rest-api-extensions) to extend the Rest API by adding missing resources (not provided by the Rest API).\nIt is possible for an extension to interact with the engine (via the API) or with any other external service (for example a database, a directory, or a web service).\n\n### Create a resource\n\n| Request URL | `http://.../API/{API_name}/{resource_name}/ `|\n|:-|:-|\n| Request Method | POST|\n| Request Payload | an item in JSON|\n| Response | the same item in JSON, containing the values provided in the posted item, completed with default values and identifiers provided by Bonita Engine.|\n\n### Read a resource\n\n| Request URL | `http://.../API/{API_name}/{resource_name}/{id} `|\n|:-|:-|\n| Request Method | GET|\n| Response | an item in JSON|\n\nExample `http://.../API/identity/user/5 `\n\n#### Extend resource response\n\nOn some resources, in GET methods the `d` (deploy) URL query parameter can be used to extend the response objects. The value of this parameter consists of an attribute for which you want to make an extended request (called a deploy) and retrieve attributes of a linked resource.\nThis means that instead of retrieving the ID or a parent or referenced resource, you can retrieve the full object.\n\nFor example, when you retrieve a task, you can also retrieve the process definition attributes in addition to the process definition ID that is already part of the task resource.\nThe supported deploy values for a task include its process (d=processId).\n\nSpecifiy multiple `d` parameter to extend several resources. For instance, to retrieve the flow node of id 143 and the associated process, process instance and assigned user, call `/API/bpm/flowNode/143?d=processId&d=caseId&d=assigned_id`\n\n#### With compound identifier\n\nThe order of the identifier parts for each resource type is given in the table above.\n\n| Request URL | `http://.../API/{API_name}/{resource_name}/{id_part1}/{id_part2} `|\n|:-|:-|\n| Request Method | GET|\n| Response | an item in JSON|\n\nExample `http://.../API/identity/membership/5/12/24 `\n\n### Update a resource\n\n| Request URL | `http://.../API/{API_name}/{resource_name}/{id} `|\n|:-|:-|\n| Request Method | PUT|\n| Request Payload | a map in JSON containing the new values for the attributes you want to change.|\n| Response | the corresponding item in JSON with new values where you requested a modification|\n\nExample `http://.../API/identity/user/5`\n\n#### With compound identifier:\n\nResponse: the corresponding item in JSON with new values where you requested a modification.\n\n| Request URL | `http://.../API/{API_name}/{resource_name}/{id_part1}/{id_part2} `|\n|:-|:-|\n| Request Method | PUT|\n| Request Payload | ` a map in JSON containing the new values for the attributes you want to change `|\n| Response | ` the corresponding item in JSON with new values where you requested a modification`|\n\nExample\n`http://.../API/identity/membership/5/12/24 `\n\n### Delete resources\n\nUse the DELETE request to remove multiple resources.\n\n| Request URL | `http://.../API/{API_name}/{resource_name}/ `|\n|:-|:-|\n| Request Method | DELETE|\n| Request Payload | A list of identifiers in JSON, for example `[\"id1\",\"id2\",\"id3\"]`. Compound identifiers are separated by '/' characters.|\n| Response | `empty `|\n\nExample\n`http://.../API/identity/membership/ `\n\n### Search for a resource\n\nThe required object is specified with a set of filters in the request URL. The URL parameters must be URL-encoded.\n\nResults are returned in a paged list, so you have to specify the page (counting from zero), and the number of results per page (count), additionally you can define a sort key (order). You can see the total number of matching results in the HTTP response header Content-Range.\nIf you are searching for business data using a custom query, there must be a [count query in the BDM](https://documentation.ofelia.com/bonita/latest/data/define-and-deploy-the-bdm). If there is no count query, results from a custom query on business data cannot be paged properly (the header Content-Range will be absent).\nFor business data default queries, the count query is defined automatically.\n\nThe available filters are the attributes of the item plus some specific filters defined by each item.\n\n| Request URL | `http://.../API/{API_name}/{resource_name}?p={page}&c={count}&o={order}&s={query}&f={filter_name}={filter_value}&f=... `|\n|:-|:-|\n| Request Method | GET|\n| Response | an array of items in JSON|\n\nExample\n`/API/identity/user?p=0&c=10&o=firstname&s=test&f=manager_id=3`\n\nFor a GET method that retrieves more than one instance of a resource, you can specify the following request parameters:\n\n* p (Mandatory): index of the page to display\n* c (Mandatory): maximum number of elements to retrieve\n* o: order of presentation of values in response: must be either `attributeName ASC` or `attributeName DESC`. The final order parameter value must be URL encoded.\n* f: list of filters, specified as `attributeName=attributeValue`. To filter on more than one attribute, specify an f parameters for each attribute. The final filter parameter value must be URL encoded.\n The attributes you can filter on are specific to the resource.\n* s: search on name or search indexes. Before Bonita 2024.1, the matching policy depended on the configuration of [word-based search](https://documentation.ofelia.com/bonita/2023.2/api/using-list-and-search-methods#word_based_search).\n For example, if word-based search was enabled, `s=Valid` returned matches containing the string \"valid\" at the start of any word in the attribute value word,\n such as \"Valid address\", \"Not a valid address\", and \"Validated request\" but not \"Invalid request\".\n If word-based search was disabled, `s=Valid` returned matches containing the string \"valid\" at the start of the attribute value, such as \"Valid address\" or \"Validated request\" but not \"Not a valid address\" or \"Invalid request\".\n Since Bonita 2024.1, the search mode can no longer be configured and a \"like-based\" algorithm is used. This means all the matching records for which the search term occurs anywhere in a phrase or a word are returned.\n\n### Errors\n\nThe API uses standard HTTP status codes to indicate the success or failure of the API call.\n\nIf you get a `401` response code :\n - make sure that the cookies have been transfered with the call\n - make sure that the cookies transfered are the ones generated during the last sucessfull login call\n - if one of the PUT, DELETE or POST method is used, make sure that the `X-Bonita-API-Token` header is included\n - if the X-Bonita-API-Token header is included, make sure that the value is the same as the one of the cookie generated during the last login\n - Maybe a logout was issued or the session has expired; try to log in again, and re run the request with the new cookies and the new value for the `X-Bonita-API-Token` header.\n"
x-logo:
url: images/ofelia-logo.svg
backgroundColor: '#19465f'
altText: Bonita API
href: /
servers:
- url: http://localhost:8080/bonita
description: Sample url for a local development server.
security:
- bonita_auth: []
bonita_token: []
- bearer_auth: []
tags:
- name: Application
x-displayName: Application
description: Manage applications. This enables you to build a consistent functional applicative environment for users to interact with business processes and business data from one place.
paths:
/API/living/application:
get:
tags:
- Application
summary: Finds living applications
description: 'Finds living applications with pagination params and filters
- can order on `id`,`creationDate`, `createdBy`, `profileId`, `token`, `displayName`, `updatedBy`, `lastUpdateDate`, `version`, `link`
- can search on `token`, `displayName`, `version`, `link`
- can filter on `token`, `displayName`, `version`, `link`, `profileId`, `creationDate`, `createdBy`, `updatedBy` , `lastUpdateDate`, `userId`
'
operationId: searchApplications
parameters:
- $ref: '#/components/parameters/pageIndex'
- $ref: '#/components/parameters/pageCount'
- $ref: '#/components/parameters/pageFilter'
- $ref: '#/components/parameters/pageOrder'
- $ref: '#/components/parameters/pageSearch'
responses:
'200':
description: 'Success '
headers:
Content-Range:
schema:
type: integer
format: int64
description: The total number of matching items
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Application'
example:
- id: '306'
link: 'true'
creationDate: '1411548289900'
icon: ''
createdBy": '1'
profileId: '2'
description: My application link description
token: myadvapp
state: ACTIVATED
displayName: My app link
updatedBy: '1'
visibility: ALL
editable: 'true'
lastUpdateDate: '1411548289900'
version: '1.0'
- id: '305'
link: 'false'
creationDate: '1411548289900'
icon: ''
createdBy": '1'
profileId: '2'
description: My application description
token: myapp
state: DEACTIVATED
displayName: My app
updatedBy: '1'
visibility: ALL
editable: 'true'
lastUpdateDate: '1411548289900'
version: '1.0'
homePageId: '26'
themeId: '1'
layoutId: '3'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
5XX:
$ref: '#/components/responses/ServerError'
post:
tags:
- Application
summary: Create a living application
deprecated: true
description: 'Create a living application (legacy application or application link).
Warning: as of 9.0.0, creating a living application using this API is deprecated.
'
operationId: createApplication
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateApplicationRequest'
description: Partial living application description
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
description: 'Success '
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
5XX:
$ref: '#/components/responses/ServerError'
x-codegen-request-body-name: body
/API/living/application/{id}:
get:
tags:
- Application
summary: Finds a living application by ID
description: 'Returns a single application for the given ID
'
operationId: getApplicationById
parameters:
- description: ID of application to return
in: path
name: id
required: true
schema:
type: string
maxLength: 250
pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
description: 'Success '
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
5XX:
$ref: '#/components/responses/ServerError'
delete:
tags:
- Application
summary: Delete a living application by ID
description: 'Delete a single application for the given ID
'
operationId: deleteApplicationById
parameters:
- description: ID of application to delete
in: path
name: id
required: true
schema:
type: string
maxLength: 250
pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
responses:
'200':
description: 'Success '
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
5XX:
$ref: '#/components/responses/ServerError'
put:
tags:
- Application
summary: Update a living application by ID
deprecated: true
description: 'Update a single application for the given ID (legacy application or application link).
Warning: as of 9.0.0, updating a living application using this API is deprecated.
'
operationId: updateApplicationById
parameters:
- description: ID of application to return
in: path
name: id
required: true
schema:
type: string
maxLength: 250
pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationUpdateRequest'
description: Partial living application description
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
description: 'Success '
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
5XX:
$ref: '#/components/responses/ServerError'
/services/application/import:
post:
tags:
- Application
summary: Import a living application
deprecated: true
description: 'Import a single application
Warning: as of 9.0.0, importing a living application using this service is deprecated.
'
operationId: importApplication
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
applicationsDataUpload:
type: string
description: Uploaded file
importPolicy:
type: string
description: Import policy
responses:
'200':
description: 'Success '
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
5XX:
$ref: '#/components/responses/ServerError'
/portal/applicationsUpload:
post:
tags:
- Application
summary: Upload a living application
deprecated: true
description: 'Upload application
Warning: as of 9.0.0, uploading a living application using the portal is deprecated.
'
operationId: uploadApplication
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/FileUploadRequest'
responses:
'200':
description: 'Success '
content:
text/plain:
schema:
type: string
maxLength: 250
pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
example: tmp_application_data.xml
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
5XX:
$ref: '#/components/responses/ServerError'
/APIv2/service/install:
post:
tags:
- Application
summary: Upload an application configuration file
deprecated: true
description: '
Upload an application configuration file in the `bconf` format.
Warning: as of 9.0.0, uploading an application configuration file using this API is deprecated.
'
operationId: uploadApplicationConfiguration
requestBody:
content:
multipart/form-data:
schema:
type: object
required:
- configuration
properties:
configuration:
type: string
format: binary
responses:
'200':
description: 'Success: the temp file name as present on the server'
content:
text/plain:
schema:
type: string
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
5XX:
$ref: '#/components/responses/ServerError'
components:
parameters:
pageOrder:
description: can order on attributes
explode: true
in: query
name: o
required: false
schema:
type: string
maxLength: 250
pattern: ^[A-Za-z0-9%]{0,250}$
style: form
example: myProp%20ASC
pageCount:
description: maximum number of elements to retrieve
explode: true
in: query
name: c
example: '10'
required: true
schema:
type: integer
minimum: 1
default: 20
format: int32
style: form
pageIndex:
description: index of the page to display
explode: true
in: query
name: p
example: '0'
required: true
schema:
type: integer
minimum: 0
default: 0
format: int32
style: form
pageSearch:
description: can search on attributes
explode: true
in: query
name: s
required: false
schema:
type: string
maxLength: 250
pattern: ^[A-Za-z0-9%]{0,250}$
style: form
pageFilter:
description: can filter on attributes with the format f={filter\_name}={filter\_value} with the name/value pair as url encoded string.
explode: true
in: query
name: f
required: false
schema:
type: array
items:
type: string
maxLength: 250
pattern: ^[A-Za-z0-9%]{0,250}$
style: form
example: abc%3d123
schemas:
ApplicationLink:
title: Application Link
description: Contains the meta information of a Bonita Living Application Link.
allOf:
- type: object
properties:
link:
description: true for an application link
type: boolean
enum:
- true
- $ref: '#/components/schemas/AbstractApplication'
- type: object
description: Contains the meta information of a Bonita Living Application Link.
example:
id: '306'
link: 'true'
creationDate: '1411548289900'
icon: ''
createdBy": '1'
profileId: '2'
description: My application link description
token: myadvapp
state: ACTIVATED
displayName: My app link
updatedBy: '1'
visibility: ALL
editable: 'true'
lastUpdateDate: '1411548289900'
version: '1.0'
ApplicationUpdateRequest:
type: object
properties:
description:
description: description of the application
type: string
displayName:
description: display name of the application
type: string
profileId:
description: profile authorized to access this application
type: string
token:
description: token of the application used to build the application URL
type: string
version:
description: version of the application
type: string
themeId:
description: '
theme id for the application
'
type: string
layoutId:
description: '
layout id for the application
'
type: string
example:
version: '1.0'
profileId: '2'
token: myapp
displayName: My app
description: My application description
themeId: '2'
layoutId: '17'
AbstractApplication:
type: object
properties:
createdBy:
description: Author user ID
type: string
maxLength: 250
pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
creationDate:
description: creation date of the application
type: string
description:
description: description of the application
type: string
displayName:
description: display name of the application
type: string
id:
description: id of the application
type: string
maxLength: 250
pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
lastUpdateDate:
description: last update date of the application
type: string
profileId:
description: profile authorized to access this application
type: string
maxLength: 250
pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
token:
description: token of the application used to build the application URL
type: string
updatedBy:
description: Last updating user ID
type: string
version:
description: version of the application
type: string
state:
description: application state
type: string
enum:
- ACTIVATED
- DEACTIVATED
visibility:
description: visibility of the Application. This value is purely indicative, changing it in the application object won't change the accessibility to the actual application.
enum:
- ALL
- TECHNICAL_USER
- RESTRICTED
x-enumDescriptions:
ALL: Everyone can use the application
TECHNICAL_USER: Only the technical user can use the application
RESTRICTED: Access to the application is determined by the user profile
editable:
description: Indicates whether the application can be modified
type: boolean
LegacyApplication:
title: Legacy application
description: Contains the meta information of a legacy Bonita Living Application.
allOf:
- type: object
properties:
link:
description: false for a legacy application
type: boolean
enum:
- false
- $ref: '#/components/schemas/AbstractApplication'
- type: object
description: Contains the meta information of a legacy Bonita Living Application.
properties:
homePageId:
description: id of the application page used as the home page
type: string
maxLength: 250
pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
layoutId:
description: id of the layout used by the application
type: string
maxLength: 250
pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
themeId:
description: id of the theme used by the application
type: string
maxLength: 250
pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
example:
id: '305'
link: 'false'
creationDate: '1411548289900'
icon: ''
createdBy": '1'
profileId: '2'
description: My application description
token: myapp
state: DEACTIVATED
displayName: My app
updatedBy: '1'
visibility: ALL
editable: 'true'
lastUpdateDate: '1411548289900'
version: '1.0'
homePageId: '26'
themeId: '1'
layoutId: '3'
CreateApplicationRequest:
type: object
properties:
link:
description: true for an application link, false for a legacy application
type: boolean
default: 'false'
enum:
- true
- false
description:
description: description of the application
type: string
displayName:
description: display name of the application
type: string
profileId:
description: profile authorized to access this application
type: string
token:
description: token of the application used to build the application URL
type: string
version:
description: version of the application
type: string
example:
link: 'false'
version: '1.0'
profileId: '2'
token: myapp
displayName: My app
description: My application description
Application:
oneOf:
- $ref: '#/components/schemas/ApplicationLink'
- $ref: '#/components/schemas/LegacyApplication'
FileUploadRequest:
type: object
description: The file to upload
properties:
file:
type: string
format: binary
Error:
type: object
additionalProperties: true
properties:
message:
type: string
description: The error message
exception:
type: string
description: The exception type
explanations:
description: Further details on the error
type: array
items:
type: string
responses:
NotFound:
description: The resource for the specified ID was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
message: Resource not found.
ServerError:
description: Unexpected error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
message: An unexpected error occured.
Forbidden:
description: Forbidden, The request contained valid data and was understood by the server, but the server is refusing action.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
message: Forbidden, The request contained valid data and was understood by the server, but the server is refusing action.
BadRequest:
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
message: Bad request
Unauthorized:
description: Authorization information is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
message: Unauthorized
securitySchemes:
bonita_auth:
name: JSESSIONID
description: '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.
'
type: apiKey
in: cookie
bonita_token:
name: X-Bonita-API-Token
description: '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.
'
type: apiKey
in: header
bearer_auth:
description: '
When Bonita runtime is configured for SSO with openID Connect it is possible To call the REST API directly with a Bearer Authorization header containing the access token.
'
type: http
scheme: bearer
x-tagGroups:
- name: Authentication
tags:
- Authentication
- PlatformAuthentication
- name: Application
tags:
- Application
- ApplicationMenu
- ApplicationPage
- FormMapping
- name: BDM
tags:
- BDM
- BusinessDataQuery
- Business Data Operations
- BDMAccessControl
- DataRetention
- name: BPM
tags:
- Activity
- ArchivedActivity
- HumanTask
- ManualTask
- Task
- UserTask
- ArchivedHumanTask
- ArchivedManualTask
- ArchivedTask
- ArchivedUserTask
- ActivityVariable
- ArchivedActivityVariable
- ProcessInstanceVariable
- ArchivedProcessInstanceVariable
- ProcessInstanceDocument
- ArchivedProcessInstanceDocument
- Actor
- ActorMember
- ProcessInstance
- ArchivedProcessInstance
- ProcessInstanceInfo
- ProcessInstanceComment
- ArchivedProcessInstanceComment
- Process
- Diagram
- ProcessInfo
- ProcessParameter
- ProcessResolutionProblem
- ProcessSupervisor
- ProcessConnectorDependency
- ConnectorFailure
- ConnectorInstance
- ArchivedConnectorInstance
- FlowNode
- ArchivedFlowNode
- Failure
- ArchivedFailure
- TimerEventTrigger
- Message
- Signal
- Delegation
- name: Custom user info
tags:
- CustomUserDefinition
- CustomUserValue
- CustomUser
- name: Identity
tags:
- ProfessionalContactData
- Group
- Membership
- Role
- User
- Authentication
- name: Platform
tags:
- PlatformAuthentication
- Platform
- License
- Information
- name: Portal
tags:
- Page
- Profile
- ProfileEntry
- ProfileMember
- Theme
- Upload
- name: System
tags:
- I18nlocale
- I18ntranslation
- Log
- Session
- Maintenance
- name: Other
tags:
- RestAPIextensions
- name: Upload
tags:
- FormFileUpload