Bizagi API for external applications

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications >

Bizagi API for external applications


Bizagi provides programmatic access to the processes functionality and to the business information underlying in your data model, by featuring a powerful service-oriented API which is ready-for-use in every Bizagi project.

Whenever there is the need to integrate Bizagi, driven by any of your existing systems or applications (i.e, fire new process instances, trigger business events in them, cancel them, get reports, or simply update business information, among others), you may rely on Bizagi API.

Bizagi API features a SOAP compliant (message-oriented), comprehensive set of web services with convenient and easy-to-use methods, while supporting WS-Security and other features and standards.



Features provided by Bizagi API are those allowing you to rely on Bizagi's BPMN/workflow engine, data access engine and queries/reports engine.

In case you wish to leverage Bizagi's UI engine (embed user interfaces or Bizagi's complete Work portal into your system), refer to Portals integration.


Major features

Bizagi product architecture follows best practices regarding integration between systems and applications, to support scenarios involving heterogeneous platforms and while promoting the use of a service-oriented architecture that in turn enables integration with corporate assets, such as an ESB (Enterprise service bus).


To use Bizagi API you do not need to incur in any technical steps (e.g, generate, rebuild or publish) in order to consider the definitions included by your specific processes or data model.

Bizagi Web services are ready-for-use and already published in every Bizagi project, while considering all possibilities contained in your processes, in order to speed up the implementation of your integration requirements.



Web services are already developed and available, though you may choose to publish them or disable them in case these are not needed (as per your business requirements).

For a production environment, you may too configure additional aspects for them (e.g, hardened security measures) at the Web application server.



Bizagi Web services (SOA layer)

Available web methods are grouped into the following categories, according to the Web service representing a major component in Bizagi's product architecture:


1. BPMN engine (Workflow) services

Methods in this Web service provide access to Bizagi BPMN engine, which is in charge of managing the process workflows.

Common examples of their use are:

Firing up one or many process instances (in Bizagi, referred to as creating cases).

Advancing to the next step of the process (in Bizagi, referred to as performing activities).

Triggering business events (in Bizagi, referred to as setting events).

Canceling process instances (in Bizagi, referred to aborting cases).

All such methods allow you to send/update business information (includes attachments) while invoking them.


2. Data access engine (Entity Manager) services

Methods in this Web service provide access to your processes data model and business information.

Common examples of their use are:

Fetching information which is stored in Bizagi entities.

Similarly, adding new data or updating existing one in Bizagi entities.

Depending on the type of entity in Bizagi, you may disable data (marked for logical deletion).

Retrieve business information from a Bizagi case (as a whole, while residing in different entities).


3. Query engine services.

Methods in this Web service provide access to data of a set of cases or at specific entities, while best handling bulk/large volumes of information (e.g, with options to fetch by pages).

Common examples of their use are:

Getting information of cases, while using optional filtering criteria.

Getting information stored in a Bizagi entity, while using optional filtering criteria.




For in-depth detail and a technical reference on these Web services and methods, refer to the child topics.