SOAP web services

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API >

SOAP web services

Overview

Bizagi SOAP web services is one of the two APIs features for programmatic access from external applications, as described at Bizagi API.

 

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.