Bonita
Bonita Cloud
Bonita Continuous Delivery
Bonita Test Toolkit
Labs
Bonita
Bonita Cloud
Bonita Continuous Delivery
Bonita Test Toolkit
Labs

Bonita

    • What is Bonita?
    • Getting started tutorial
      • Overview
      • Download and install
      • Draw a BPMN diagram
      • Define business data model (BDM)
      • Declare business variables
      • Declare contracts
      • Create web user Interfaces
      • Define who can do what
      • Configure an email connector
      • Design an application page
      • Create an application
    • Release notes
    • Purge tool changelog
    • Application and Process Design
      • Application and process design overview
        • Key concepts
        • Comparison of 7.x and 6.x
        • Lifecycle and profiles
        • Design methodology
      • Bonita Studio preferences
      • Bonita Studio hints and tips
      • Organization
        • Overview
        • Approaches to managing organizations and actor mapping
        • Organization management in Bonita Studio
        • Custom User Information in Bonita Studio
        • LDAP synchronizer
      • Profiles
        • Overview
        • Profile editor
      • Process modeling
        • Diagrams
          • Overview
          • Pools and lanes
          • Tasks
          • Gateways
          • Transitions
          • Events
          • Called processes
          • Event subprocesses
          • Text annotations
        • Naming conventions
        • Refactoring
        • Actors
        • Actor filters
        • Iteration
      • Data
        • Data handling overview
        • Define and deploy the BDM
        • Define access control on business objects
        • Specify data in a process definition
        • Parameters
        • Contracts and contexts
        • Documents
        • Search keys
        • Expressions and scripts
        • Operations
      • User Interface development
        • Overview
        • Pages
        • Forms
        • Layout
        • Theme
        • UI Designer
          • Overview
          • Create or modify UI artifacts
          • Widgets
          • Widget properties
          • Widget use examples
            • Repeat a container for a collection of data
          • Fragments
          • Custom widgets
          • Data management
          • Variables
          • Appearance
          • Assets
          • Multi-language pages
          • Migrate a form from 6.x
        • Cache configuration and policy
      • Application descriptor
      • Connectivity
        • Overview
        • Alfresco
        • CMIS
        • Database
          • List of database connectors
          • Database connector configuration
          • Graphical query builder
          • Initialize a variable from a database without scripting or Java code
        • Insert data in a .docx/.odt template
        • Google Calendar
        • LDAP
        • Messaging
        • Generate PDF from an Office document
        • Salesforce
        • SAP JCo 3
        • Script
        • Twitter
        • UiPath
        • Web service
          • Web service connector overview
          • Web service connector tutorial
      • Reporting
        • Overview
        • Set up a reporting database
        • Set up KPIs
        • Create a report
      • Import and export a process
      • Process configuration
        • Overview
        • Environments
        • Configure a process
        • Manage JAR files
        • Manage dependencies
      • Process testing
        • Overview
        • Configure a test organization
        • Run a process from Bonita Studio for testing
        • Log files
      • Project deployment in Bonita Development Suite
      • Build a process for deployment
    • Installation
      • Overview
      • Bonita Studio installation
      • Basic Bonita Platform installation
        • Hardware and software requirements
        • Tomcat bundle
        • Custom Deployment into existing Tomcat installation
        • Convert a WildFly into a Tomcat installation
        • Platform configuration
        • Database creation and customization to work with Bonita
        • First steps after setup
        • Licenses
      • Bonita docker installation
      • Advanced Bonita Platform installation
        • Security and authentication
          • User authentication overview
          • Active Directory or LDAP authentication
          • Single sign-on with CAS
          • Single sign-on with SAML
          • Single sign-on with Kerberos
          • Enforce password policy
          • REST API authorization
          • CSRF security
          • Enable CORS in Tomcat bundle
          • SSL
          • Tenant administrator credentials
          • Guest user access
        • Set log and archive levels
        • Configurable Archive
        • Performance
          • Performance tuning
          • Performance troubleshooting
          • Purging unnecessary archive data
        • Use gzip compression
        • Set Bonita behind a reverse-proxy
        • Bonita in a cluster
          • Overview of Bonita in a cluster
          • Install a Bonita cluster
        • Multi-tenancy and tenant configuration
        • Install Tomcat with Bonita as a service in Windows
      • Bonita Versions
      • Embed engine - Lab
      • Community to Subscription upgrade
    • Bonita User Interfaces in Production
      • Overview
      • Languages
      • Log in and log out
      • Navigation between User Interfaces
      • User Interface for End-users
        • User Portal
          • Process list
          • Case list
          • Task list
        • Mobile User Portal
        • Bonita User Application
          • Overview
          • Process list
          • Case list
          • Task list
      • User Interface for Administrators
        • Live update
        • Administrator Portal
          • Process Management
            • Monitoring
            • Process list
            • Case list
            • Task list
            • Analytics
          • Organization
            • Organization Management
            • Install/export an organization
            • Manage groups
            • Manage roles
            • Manage users
              • Manage a user
              • Deactivate a user
              • Custom User Information
            • Profiles
              • Overview
              • Profiles Management
              • Special users
          • BDM Management
          • Resources
            • Resources management
            • Pages
            • Forms
            • Layouts
            • Themes
            • REST API extensions
          • Applications
          • Look & Feel
            • Manage Look & Feel
            • Create a new Look & Feel
          • License information
        • Bonita Administrator Application
          • Overview
          • Process Management
            • Monitoring
            • Process list
            • Case list
            • Task list
          • Organization
            • Organization Management
            • Install/export an organization
            • Manage groups
            • Manage roles
            • Manage users
              • Manage a user
              • Custom User Information
            • User profiles
              • Overview
              • Profiles Management
          • BDM Management
          • Resources
            • Resources management
            • Pages
            • Forms
            • Layouts
            • Themes
            • REST API extensions
          • Applications
          • License information
    • Technical Monitoring
      • Overview
      • Work execution audit
    • Technical Platform Administration
      • Performance tuning
      • Performance troubleshooting
      • Cluster administration
      • Bonita Runtime Maintenance Operations
      • Back up Bonita Platform
      • Configurable Archive
      • Fault tolerance mechanisms
      • Update Bonita versions
        • Update overview
        • Update with Migration Tool
        • Update with Update Tool
        • Update tools changelog
    • Development
      • Platform extensibility overview
      • Connectors
        • Overview
        • Bonita connector archetype
      • Create an actor filter
      • Create a rest api extension
      • API glossary
      • REST API
        • Overview
        • REST Authentication
        • Application API
        • Access control API
        • BDM API
        • BPM API
          • Activities, Tasks and Flow nodes
          • Data and Documents
          • Actors, Process and Connectors
          • Cases (Process Instances)
        • Customuserinfo API
        • Form API
        • Identity API
        • Platform API
        • Portal API
        • System API
        • Tenant API
        • REST API extensions
        • Manage files using upload servlet and REST API
      • Engine API
        • Overview
        • Create your first project with the Engine APIs and Maven
        • Configure connection to Bonita Engine
        • Javadoc
        • Examples
          • Manage a process
          • Handle a failed activity
          • Manage an organization
          • Manage users
          • Handle documents
          • Create administration tools
          • Restore the default Look & Feel
          • Manage the platform
        • List and search methods
        • Queriable logger
        • Log in with CAS
      • Bonita Portal URLs
      • Living application
        • Bonita Layout
        • Living application layout
        • Multi-language applications
        • Customize layouts
        • Customize living application theme
      • Logs
      • Workspaces and projects
      • Continuous integration
        • Automate builds
        • Set up continuous integration
    • Collaboration
      • Project documentation generation
      • Using a shared project
    • Howtos
      • Create a case overview page using the UI Designer
      • Create unique task names for the user task list
      • Control and validate forms in the UI Designer
      • Manage a list of documents
      • Manage multiple references in Business Objects
      • Map authorization rules
      • Use the rich textarea widget in a mail template
      • Manage dates and times in BDM and User Interfaces
      • Manage BDM in custom Rest APIs
      • Share a project on GitHub
      • Migrate a SVN repository to a Git repository
      • Configure Maven
      • Create a vertical tabs container for all devices
      • Use Groovy in Bonita
      • Enable Adaptive Case Management with Bonita
      • Create an event handler
    • Contributing
      • Build Bonita Community edition from source files
      • Bonita Engine developer documentation
        • Bonita Engine architecture overview
        • Flow node states
        • Timers execution
        • Connectors execution
        • Works
          • Work execution
          • Work locking
        • BPM process / task execution sequence
        • How flow node is executed
        • How a flownode is completed
        • How a call activity is executed
        • How a process is executed
        • How an event is executed
        • BDM deployment
Bonita 2021.1
  • Bonita
    • 2022.2
    • 2022.1
    • 2021.2
    • 2021.1
    • 7.11
    • 7.10
    • 7.9
    • 7.8
    • Archives
    • 2023.1-alpha
  • Bonita Cloud
    • latest
  • Bonita Continuous Delivery
    • 3.6
    • 3.5
    • 3.4
  • Bonita Test Toolkit
    • 1.0
  • Labs
    • latest
  • Bonita
  • Development
  • REST API
  • BPM API
2022.2 2022.1 2021.2 2021.1 7.11 7.10 7.9 7.8 Archives 2023.1-alpha
Edit History Contribution

REST API BPM API

Easily retrieve human or service tasks, call activities, and subprocesses with BPM APIs. Perform maintenance tasks.

Details available here :

  • Activities, Tasks and Flow nodes

  • Data and Documents

  • Actors, Process and Connectors

  • Cases (Process Instances)

Thanks to these technologies we built this great documentation site:

Antora logo Asciidoctor logo Algolia logo Netlify logo Surge logo

Bonitasoft fully supports digital operations and IT modernization with Bonita, an open-source and extensible platform for automation and optimization of business processes. The Bonita platform accelerates development and production with clear separation between capabilities for visual programming and for coding. Bonita integrates with existing information systems, orchestrates heterogeneous systems, and provides deep visibility into processes across the organization.

  • Community
  • Bonitasoft
  • Events
  • Terms of use

© Bonitasoft, S.A. All rights reserved. Privacy, Legal notices