Overview
Bizagi provides programmatic access to the underlying business information in your data model, through a powerful API based on RESTful and OData services.
This API lets you work with your processes' data from external applications, such as information related to processes, cases, or experience-centric features.
Basic OData concepts
Bizagi complies with OData version 4.0, by featuring a comprehensive set of possibilities to work with the underlying data of the business processes.
OData services are built as RESTful services (featuring resources, accessible throughout URLs and having every resource use a unique identifier).
RESTful services, rely on the set of operational HTTP methods as shown in the table below:
HTTP METHOD |
DESCRIPTION |
|---|---|
GET |
A read-only operation used to query the server for specific information. It is both an idempotent (no matter how many times you apply the operation, the result is always the same), and safe operation. Invoking a GET does not change the state of the server. |
POST |
POST is the only non-idempotent and unsafe operation of HTTP (it can modify the service in a unique way). You may or may not send information with the request. You may or may not receive information from the response. |
For more information about the OData specification, refer to http://www.odata.org/.
Getting Started
1.Authentication: learn about the Bizagi API authentication mechanism.
2.Quick start guide: see a quick start guide for an invocation of an OData method
3.Bizagi information exposed in OData: set the business information that you can expose through OData services.
4.API service index: see the complete list of the Bizagi API's endpoints
Considerations
While using OData HTTP methods with special characters in the parameters fields, you have to take into account some special cases where the those characters have to be replaced with their hexadecimal value. For more information visit Special characters considerations in OData.
Examples
You can see a comprehensive set of examples for invocation of the Bizagi API.
These type of services can be used to access business data (resources classified as part of the data services). Through the data services you can do the following in Bizagi:
•Create a new case for processes.
•Get entities' information.
•Obtain the list of pending cases with their pending activities (whether or not they are a Persona).
•Complete a pending activity or event by submitting information applicable to that activity or event of an end-user (whether or not they are a Persona).
•Search for a specific case by providing its case identifier and obtain its details.
•Obtain information related to a Persona for example My stuff or My searches, and execute actions on the Persona Wizard.
Through the metadata services you can obtain details focused on how to further invoke data services, such as: Obtaining the list of processes, Personas in the project, or which Searches, Relevant processes or My stuff collections they have under the Persona Wizard.
Query services expose methods to retrieve information of entities and processes entities. These services are useful if you are looking to generate processes reports using the Bizagi API, for example, a report of a process using business information.
See how you can create a code in C# to invoke OData methods.
Lookup services
The Bizagi OData exposes some useful endpoints that help to understand the structure of entities, collections, or how to search metadata, that you need to understand before invoking other services. See lookup services.
Last Updated 2/26/2024 2:27:44 PM