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-profile-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 Profile 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 Profile 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: Profile
name: Profile
x-displayName: Profile
paths:
/API/portal/profile:
get:
description: 'Finds Profiles with pagination params and filters
- can search on `name`
- can filter on `name`,`hasNavigation`
- can order on `name`'
operationId: searchProfiles
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 search on attributes
explode: true
in: query
name: s
required: false
schema:
maxLength: 250
pattern: ^[A-Za-z0-9%]{0,250}$
type: string
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/Profile'
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 Profiles
tags:
- Profile
x-accepts:
- application/json
post:
deprecated: true
description: '!edition
Create the Profile
Warning: as of 9.0.0, creating profiles using this API is deprecated.'
operationId: createProfile
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProfileCreateRequest'
description: Partial Profile description
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Profile'
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.
5XX:
content:
application/json:
example:
message: An unexpected error occured.
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error.
summary: Create the Profile
tags:
- Profile
x-codegen-request-body-name: body
x-content-type: application/json
x-accepts:
- application/json
servers:
- description: Sample url for a local development server.
url: http://localhost:8080/bonita
/API/portal/profile/{id}:
delete:
description: Delete the single Profile for the given ID
operationId: deleteProfileById
parameters:
- description: ID of the Profile 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 Profile by ID
tags:
- Profile
x-accepts:
- application/json
get:
description: Returns the single Profile for the given ID
operationId: getProfileById
parameters:
- description: ID of the Profile 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/Profile'
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 Profile by ID
tags:
- Profile
x-accepts:
- application/json
put:
deprecated: true
description: '!edition
Update the Profile for the given ID
Warning: as of 9.0.0, updating a profile using this API is deprecated.'
operationId: updateProfileById
parameters:
- description: ID of the Profile to return
explode: false
in: path
name: id
required: true
schema:
maxLength: 250
pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProfileUpdateRequest'
description: Partial Profile description
required: true
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: Update the Profile by ID
tags:
- Profile
x-content-type: application/json
x-accepts:
- application/json
servers:
- description: Sample url for a local development server.
url: http://localhost:8080/bonita
/portal/profilesUpload:
post:
deprecated: true
description: '!edition
Upload profiles
Warning: as of 9.0.0, uploading profiles using the portal is deprecated.'
operationId: uploadprofiles
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/FileUploadRequest'
responses:
'200':
content:
text/plain:
schema:
example: tmp_profiles_data.xml
maxLength: 250
pattern: ^[A-Za-z0-9\_\-\.]{0,250}$
type: string
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.
5XX:
content:
application/json:
example:
message: An unexpected error occured.
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error.
summary: Upload profiles
tags:
- Profile
x-content-type: multipart/form-data
x-accepts:
- application/json
- text/plain
servers:
- description: Sample url for a local development server.
url: http://localhost:8080/bonita
/services/profile/import:
post:
deprecated: true
description: 'Import profiles
Warning: as of 9.0.0, importing profiles using this service is deprecated.'
operationId: importProfiles
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/importProfiles_request'
responses:
'200':
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: Import profiles
tags:
- Profile
x-content-type: application/x-www-form-urlencoded
x-accepts:
- application/json
servers:
- description: Sample url for a local development server.
url: http://localhost:8080/bonita
components:
schemas:
ProfileCreateRequest:
example:
name: MyCustomProfile
description: This is my custom profile
properties:
description:
description: a description of the profile
type: string
name:
description: profile name
type: string
type: object
ProfileUpdateRequest:
example:
displayName: My app
description: My application description
properties:
description:
description: description of the Profile
type: string
displayName:
description: display name of the Profile
type: string
type: object
Profile:
description: Profile
example:
id: 101
creationDate: 2014-12-04 16:29:23.434000
icon: /profiles/profileDefault.png
createdBy: 1
description: This is my custom profile
name: MyCustomProfile
is_default: false
lastUpdateDate: 2014-12-04 16:29:23.434000
updatedBy: 1
properties:
id:
description: profile id
type: string
creationDate:
description: date and time of profile creation
type: string
icon:
description: icon used in the portal to represent the profile
type: string
createdBy:
description: id of the uer who created the profile
type: string
description:
description: a description of the profile
type: string
name:
description: profile name
type: string
isdefault:
description: 'true | false '
type: boolean
lastUpdateDate:
description: date and time of the last update to the profile
type: string
updatedBy:
description: the id of the user who last updated the profile
type: string
type: object
FileUploadRequest:
description: The file to upload
properties:
file:
format: binary
type: string
type: object
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
importProfiles_request:
properties:
profilesDataUpload:
description: Uploaded file
type: string
importPolicy:
description: Import policy
type: string
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