OData services

<< Click to Display Table of Contents >>

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

OData services

Overview

Bizagi provides programmatic access to the underlying business information in your data model, by featuring a powerful API based on RESTful and OData services.

This API allows you to work with your processes data from external applications, especially for the Experience design features for instance to start new relevant processes, execute searches and trigger actions, or to fetch pending cases in other portals or tools of your choice.

 

Basic OData concepts

Bizagi complies to OData version 4.0, by featuring a comprehensive set of possibilities to work with the underlying of the business processes.

OData services are built as RESTful services (featuring resources, accessible throughout URLs and while having every resource use a unique identifier).

 

As RESTful services, these rely on the fixed set of operational HTTP methods as shown in the table below:

 

HTTP METHOD

DESCRIPTION

GET

A read-only operation.

It is 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 (means that it is allowed to 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.

 

Such OData services rely on the OAuth protocol as well.

For more information about the OData specification, refer to http://www.odata.org/.

 

OAuth

Bizagi API implements 2 of the flows treated under the OAuth version 2.0 specification, those which are most commonly used:

 

1.Authorization code:

This allows the client application to authenticate with inputted credentials on runtime (throughout a login page).

This means that this flow is designed for human interaction, where requests will use impersonation of the end users.

For more information about its specification, refer to https://tools.ietf.org/html/rfc6749#section-1.3.1.

 

2.Client credentials:

This allows server to server integration where there is no need to use further specific credentials of the end users.

For more information about its specification, refer to https://tools.ietf.org/html/rfc6749#section-1.3.4.

 

Data and metadata services

Bizagi offers two different OData services: one handling your own definitions (data) and another one handling definitions stored in Bizagi's model (metadata).

 

For more information about the first OData service, refer to Data services.

For more information about the second OData service, refer to Metadata services.

 

To get started and test for yourself the use of the OData services, refer to Getting started.