Bonitasoft Archived Process Instance API
ArchivedProcessInstance
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/bonitasoft-com:bonitasoft-com-archivedprocessinstance-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Bonitasoft Com Archived Process Instance API
version: 1.0.9
license:
name: GPL-v2.0
url: http://www.gnu.org/licenses/gpl-2.0.txt
x-logo:
url: images/ofelia-logo.svg
backgroundColor: '#19465f'
altText: Bonita API
href: /
description: 'Operations tagged ArchivedProcessInstance across 2 of this provider''s published API definitions: bonita-java-client-openapi.yaml, bonita-java-client.yaml. Each path carries the servers of the definition it was published in.'
servers:
- description: Sample url for a local development server.
url: http://localhost:8080/bonita
security:
- bonita_auth: []
bonita_token: []
- bearer_auth: []
tags:
- description: ArchivedProcessInstance
name: ArchivedProcessInstance
x-displayName: ArchivedProcessInstance
paths:
/API/bpm/archivedCase:
get:
description: 'Finds archived ProcessInstances (or ProcessInstance) with pagination params and filters
You can order on `id`, `processDefinitionId`, `startedBy`, `startedBySubstitute`, `startDate`, `endDate`, `lastUpdate`, `archivedDate`, `sourceObjectId`
You can filter on :
* `sourceObjectId`: The original process instance ID before the process instance was archived
* `processDefinitionId`: The process definition ID
* `rootCaseId`: the root process instance ID (since version 10.3 - 2025.1)
* `name`: the process name
* `started_by`: the ID of the user who started the process
* `team_manager_id`: allow to retrieve the process instances in which all users with this manager ID ar involved)
* `supervisor_id`: allow the retrived the process instances of all processes the user with this ID is supervisor of) beware you cannot use team_manager_id and supervisor_id at the same time
* `searchIndex1Value`, `searchIndex2Value`, `searchIndex3Value`, `searchIndex4Value`, `searchIndex5Value`: the value of the corresponding search index (since version 10.3 - 2025.1)'
operationId: searchArchivedProcessInstances
parameters:
- description: index of the page to display
example: '0'
explode: true
in: query
name: p
required: true
schema:
default: 0
format: int32
minimum: 0
type: integer
style: form
- description: maximum number of elements to retrieve
example: '10'
explode: true
in: query
name: c
required: true
schema:
default: 20
format: int32
minimum: 1
type: integer
style: form
- description: can filter on attributes with the format f={filter\_name}={filter\_value} with the name/value pair as url encoded string.
example: abc%3d123
explode: true
in: query
name: f
required: false
schema:
items:
maxLength: 250
pattern: ^[A-Za-z0-9%]{0,250}$
type: string
type: array
style: form
- description: can order on attributes
example: myProp%20ASC
explode: true
in: query
name: o
required: false
schema:
maxLength: 250
pattern: ^[A-Za-z0-9%]{0,250}$
type: string
style: form
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ArchivedProcessInstance'
type: array
description: 'Success '
headers:
Content-Range:
description: The total number of matching items
explode: false
schema:
format: int64
type: integer
style: simple
'400':
content:
application/json:
example:
message: Bad request
schema:
$ref: '#/components/schemas/Error'
description: Bad request.
'401':
content:
application/json:
example:
message: Unauthorized
schema:
$ref: '#/components/schemas/Error'
description: Authorization information is missing or invalid.
'403':
content:
application/json:
example:
message: Forbidden, The request contained valid data and was understood by the server, but the server is refusing action.
schema:
$ref: '#/components/schemas/Error'
description: Forbidden, The request contained valid data and was understood by the server, but the server is refusing action.
5XX:
content:
application/json:
example:
message: An unexpected error occured.
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error.
summary: Finds ArchivedProcessInstances
tags:
- ArchivedProcessInstance
x-accepts:
- application/json
servers:
- description: Sample url for a local development server.
url: http://localhost:8080/bonita
/API/bpm/archivedCase/{id}:
delete:
description: Delete the single ArchivedProcessInstance for the given ID
operationId: deleteArchivedProcessInstanceById
parameters:
- description: ID of the ArchivedProcessInstance to delete
explode: false
in: path
name: id
required: true
schema:
maxLength: 250
pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
type: string
style: simple
responses:
'200':
description: OK
'400':
content:
application/json:
example:
message: Bad request
schema:
$ref: '#/components/schemas/Error'
description: Bad request.
'401':
content:
application/json:
example:
message: Unauthorized
schema:
$ref: '#/components/schemas/Error'
description: Authorization information is missing or invalid.
'403':
content:
application/json:
example:
message: Forbidden, The request contained valid data and was understood by the server, but the server is refusing action.
schema:
$ref: '#/components/schemas/Error'
description: Forbidden, The request contained valid data and was understood by the server, but the server is refusing action.
'404':
content:
application/json:
example:
message: Resource not found.
schema:
$ref: '#/components/schemas/Error'
description: The resource for the specified ID was not found.
5XX:
content:
application/json:
example:
message: An unexpected error occured.
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error.
summary: Delete the ArchivedProcessInstance by ID
tags:
- ArchivedProcessInstance
x-accepts:
- application/json
get:
description: Returns the single ArchivedProcessInstance for the given ID
operationId: getArchivedProcessInstanceById
parameters:
- description: ID of the ArchivedProcessInstance to return
explode: false
in: path
name: id
required: true
schema:
maxLength: 250
pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ArchivedProcessInstance'
description: 'Success '
'400':
content:
application/json:
example:
message: Bad request
schema:
$ref: '#/components/schemas/Error'
description: Bad request.
'401':
content:
application/json:
example:
message: Unauthorized
schema:
$ref: '#/components/schemas/Error'
description: Authorization information is missing or invalid.
'403':
content:
application/json:
example:
message: Forbidden, The request contained valid data and was understood by the server, but the server is refusing action.
schema:
$ref: '#/components/schemas/Error'
description: Forbidden, The request contained valid data and was understood by the server, but the server is refusing action.
'404':
content:
application/json:
example:
message: Resource not found.
schema:
$ref: '#/components/schemas/Error'
description: The resource for the specified ID was not found.
5XX:
content:
application/json:
example:
message: An unexpected error occured.
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error.
summary: Finds the ArchivedProcessInstance by ID
tags:
- ArchivedProcessInstance
x-accepts:
- application/json
servers:
- description: Sample url for a local development server.
url: http://localhost:8080/bonita
/API/bpm/archivedCase/{id}/context:
get:
description: Returns the Context for the given ArchivedProcessInstance ID
operationId: getContextByArchivedProcessInstanceId
parameters:
- description: ID of the ArchivedProcessInstance that has the Context to return
explode: false
in: path
name: id
required: true
schema:
maxLength: 250
pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
type: string
style: simple
responses:
'200':
content:
application/json:
example:
myBusinessData_ref:
name: myBusinessData
type: com.company.model.BusinessObject1
link: API/bdm/businessData/com.company.model.BusinessObject1/2
storageId: 2
storageId_string: '2'
myDocument_ref:
id: 1
processInstanceId: 3
name: myDocument
author: 104
creationDate: 1434723950847
fileName: TestCommunity-1.0.bos
contentMimeType: null
contentStorageId: '1'
url: documentDownload?fileName=TestCommunity-1.0.bos&contentStorageId=1
description: ''
version: '1'
index: -1
contentFileName: TestCommunity-1.0.bos
schema:
additionalProperties: true
type: object
description: 'Success '
'400':
content:
application/json:
example:
message: Bad request
schema:
$ref: '#/components/schemas/Error'
description: Bad request.
'401':
content:
application/json:
example:
message: Unauthorized
schema:
$ref: '#/components/schemas/Error'
description: Authorization information is missing or invalid.
'403':
content:
application/json:
example:
message: Forbidden, The request contained valid data and was understood by the server, but the server is refusing action.
schema:
$ref: '#/components/schemas/Error'
description: Forbidden, The request contained valid data and was understood by the server, but the server is refusing action.
'404':
content:
application/json:
example:
message: Resource not found.
schema:
$ref: '#/components/schemas/Error'
description: The resource for the specified ID was not found.
5XX:
content:
application/json:
example:
message: An unexpected error occured.
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error.
summary: Finds the Context by ArchivedProcessInstance ID
tags:
- ArchivedProcessInstance
x-accepts:
- application/json
servers:
- description: Sample url for a local development server.
url: http://localhost:8080/bonita
components:
schemas:
Error:
additionalProperties: true
example:
exception: exception
explanations:
- explanations
- explanations
message: message
properties:
message:
description: The error message
type: string
exception:
description: The exception type
type: string
explanations:
description: Further details on the error
items:
type: string
type: array
type: object
ProcessInstance:
description: ProcessInstance (Case) is an instance of a process. When you start a process, it creates a process instances.
example:
id: 1
end_date": ''
failedFlowNodes": 9
startedBySubstitute": 345
start": 2014-11-27 17:55:00.906000
activeFlowNodes": '9'
state": started
rootCaseId": '1'
callerId": '-1'
started_by": 989
processDefinitionId": '5777042023671752656'
last_update_date": 2014-11-27 17:55:00.906000
searchIndex1Label: mySearchIndex1Label
searchIndex2Label: mySearchIndex2Label
searchIndex3Label: mySearchIndex3Label
searchIndex4Label: mySearchIndex4Label
searchIndex5Label: mySearchIndex5Label
searchIndex1Value: mySearchIndex1Value
searchIndex2Value: mySearchIndex2Value
searchIndex3Value: mySearchIndex3Value
searchIndex4Value: mySearchIndex4Value
searchIndex5Value: mySearchIndex5Value
properties:
id:
description: the identifier of the ProcessInstance (Case)
type: string
end_date:
description: the date set when the process instance is closed
type: string
failedFlowNodes:
description: count of failed flow nodes if parameter n=failedFlowNodes is given
type: string
startedBySubstitute:
description: the identifier of the substitute user (as Process manager or Administrator) who started the process. It can be also the substitute user if d=startedBySubstitute is given.
type: string
start:
description: the starting date of the case
type: string
activeFlowNodes:
description: count of active flow nodes if parameter n=activeFlowNodes is given
type: string
state:
description: 'state: an enum that represent the state of the process instances'
enum:
- initializing
- started
- suspended
- cancelled
- aborted
- completing
- completed
- error
- aborting
type: string
rootCaseId:
description: the identifier of the container of the case
type: string
started_by:
description: the identifier of the user who started the case
type: string
processDefinitionId:
description: the identifier of the process related of the case
type: string
last_update_date:
description: the date of the last update done on the case
type: string
searchIndex1Label:
description: the 1st search index label (from 6.5, in Subscription editions only)
type: string
searchIndex2Label:
description: the 2nd search index label (from 6.5, in Subscription editions only)
type: string
searchIndex3Label:
description: the 3rd search index label (from 6.5, in Subscription editions only)
type: string
searchIndex4Label:
description: the 4th search index label (from 6.5, in Subscription editions only)
type: string
searchIndex5Label:
description: the 5th search index label (from 6.5, in Subscription editions only)
type: string
searchIndex1Value:
description: the 1st search index value (from 6.5, in Subscription editions only)
type: string
searchIndex2Value:
description: the 2nd search index value (from 6.5, in Subscription editions only)
type: string
searchIndex3Value:
description: the 3rd search index value (from 6.5, in Subscription editions only)
type: string
searchIndex4Value:
description: the 4th search index value (from 6.5, in Subscription editions only)
type: string
searchIndex5Value:
description: the 5th search index value (from 6.5, in Subscription editions only)
type: string
callerId:
description: the identifier of the BPM entity who started the process. E.g. the call activity instance Id if it was started by a call activity or -1 if it was started by a user (since version 10.3 - 2025.1)
type: string
type: object
ArchivedProcessInstance:
allOf:
- $ref: '#/components/schemas/ProcessInstance'
- description: A completed instance of a process.
example:
id: 9
end_date: 2014-10-22 10:57:00.299000
startedBySubstitute: '4'
sourceObjectId: '3'
start: 2014-10-22 10:56:53.415000
state: completed
rootCaseId: '3'
callerId": '-1'
started_by: '4'
archivedDate: 2014-10-22 10:57:00.299000
processDefinitionId: '6054482369194211518'
last_update_date": 2014-10-22 10:57:00.299000
searchIndex1Label: case9SearchIndex1Label
searchIndex2Label: case9SearchIndex2Label
searchIndex3Label: case9SearchIndex3Label
searchIndex4Label: case9SearchIndex4Label
searchIndex5Label: case9SearchIndex5Label
searchIndex1Value: case9SearchIndex1Value
searchIndex2Value: case9SearchIndex2Value
searchIndex3Value: case9SearchIndex3Value
searchIndex4Value: case9SearchIndex4Value
searchIndex5Value: case9SearchIndex5Value
properties:
sourceObjectId:
description: the id of the process instance before it was archived
type: string
archivedDate:
description: the date set when the process instance was archived
type: string
type: object
example:
end_date: end_date
searchIndex5Label: searchIndex5Label
archivedDate: archivedDate
processDefinitionId: processDefinitionId
searchIndex3Value: searchIndex3Value
searchIndex4Value: searchIndex4Value
searchIndex2Label: searchIndex2Label
start: start
searchIndex1Value: searchIndex1Value
sourceObjectId: sourceObjectId
searchIndex3Label: searchIndex3Label
failedFlowNodes: failedFlowNodes
startedBySubstitute: startedBySubstitute
searchIndex5Value: searchIndex5Value
searchIndex2Value: searchIndex2Value
rootCaseId: rootCaseId
id: id
state: initializing
searchIndex1Label: searchIndex1Label
callerId: callerId
activeFlowNodes: activeFlowNodes
started_by: started_by
searchIndex4Label: searchIndex4Label
last_update_date: last_update_date
securitySchemes:
bonita_auth:
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.
'
in: cookie
name: JSESSIONID
type: apiKey
bonita_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.
'
in: header
name: X-Bonita-API-Token
type: apiKey
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.
'
scheme: bearer
type: http
x-refined-from:
- bonita-java-client-openapi.yaml
- bonita-java-client.yaml
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