Data services

<< Click to Display Table of Contents >>

Navigation:  Bizagi API >

Data services

Overview

Bizagi features OData services for external applications to work with the data held in Bizagi.

There are two different OData services: one handling your own definitions (data) and another one handling definitions stored in Bizagi's system entities and parameter entities (metadata), as described at Bizagi API.

This section describes how to use the OData services that handle data (referred to from this point on, as Data services).

 

Important

The Data services in Bizagi consider the context and information relevant to a specific user (Stakeholder), though there are a some which apply to all users without the need of being Stakeholders.

That user being considered is the one bound to the registered OAuth application whose access keys are used on the authenticating request.

 

Data services base URL

In order to access the Data services, you will need to part from the following base URL:

[your_bizagi_project_url]/odata/data

 

Consider:

[your_bizagi_project_url]: Corresponds to the URL where end users access the Bizagi Work portal.

For instance for an on-premise Bizagi project, such URL would be:

https://[your_server]/[your_project]/oauth2/server/token

While for Bizagi Cloud projects, such URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/oauth2/server/token

 

Resources in Data services

The following table provides a reference about further resources handled by the Data services:

 

Resource

Description

URL example

Stuff

Returns a list of the collections found at the My stuff section (for the given authenticated Stakeholder).

For more information about this resource and its further resources or query options, refer to My Stuff data.

[your_bizagi_project_url]/odata/data/stuff

Searches

Returns a list of the searches defined, providing its metadata (for the given authenticated Stakeholder).

For more information about this resource and its further resources or query options, refer to Searches data.

[your_bizagi_project_url]/[your_project]/odata/data/searches

Relevants

Returns a list of the relevant processes as found at the Relevant to me section, providing its metadata (for the given authenticated Stakeholder).

For more information about this resource and its further resources or query options, refer to Relevant to me data.

[your_bizagi_project_url]/[your_project]/odata/data/relevants

Stakeholders

Returns a list of all Stakeholders applicable (to the given authenticated Stakeholder).

For more information about this resource and its further resources or query options, refer to Stakeholders data.

[your_bizagi_project_url]/[your_project]/odata/data/stakeholders

userProfile

Returns the single details of the given authenticated user.

This is applicable to all users, regardless of being Stakeholders or not.

For more information about this resource, refer to User profile data.

[your_bizagi_project_url]/[your_project]/odata/data/userProfile

Processes

Returns a list of all processes, providing its metadata (for the given authenticated user).

This is applicable to all users, regardless of being Stakeholders or not.

For more information about this resource and its further resources or query options, refer to Processes data.

[your_bizagi_project_url]/[your_project]/odata/data/processes

cases

Returns a list of all pending cases as available in the Inbox (for the given authenticated user).

This is applicable to all users, regardless of being Stakeholders or not.

For more information about this resource and its further resources or query options, refer to Cases from Work portal.

[your_bizagi_project_url]/[your_project]/odata/data/cases

 

 

Notice that these resources' definition is provided for an HTTP GET action with the base URL ([your_bizagi_project_url]/odata/data):

{

  "@odata.context": "[your_bizagi_project_url]/odata/data/$metadata",

  "value": [

    {

      "name": "stuff",

      "kind": "EntitySet",

      "url": "stuff"

    },

    {

      "name": "searches",

      "kind": "EntitySet",

      "url": "searches"

    },

    {

      "name": "relevants",

      "kind": "EntitySet",

      "url": "relevants"

    },

    {

      "name": "stakeholders",

      "kind": "EntitySet",

      "url": "stakeholders"

    },

    {

      "name": "userProfile",

      "kind": "Singleton",

      "url": "userProfile"

    },

    {

      "name": "processes",

      "kind": "EntitySet",

      "url": "processes"

    },

    {

            "name": "cases",

      "kind": "EntitySet",

      "url": "cases"

    }

  ]

}