Data services

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API > OData services > Services index >

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 handles your own definitions (data) and the other handles definitions stored in Bizagi's system and parameter entities (metadata), as described in the 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 take into account the context and information relevant to a specific Stakeholder, though there are some services that apply to all users.

The user in quiestion is the one bound to the registered OAuth application whose access keys are used in the authentication request. By using the authentication token, Bizagi can control the data being accessed through services: only the information that a user has access to will be provided as the result of a service invocation.

 

Data services base URL

To access the Data services, you start 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 an on-premises Bizagi project, the URL would be:

https://[your_server]/[your_project]/odata/data

For Automation Service projects, the URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/odata/data

 

Resources in Data services

This table provides a reference to 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 authenticated Stakeholder.

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

[your_bizagi_project_url]/odata/data/stuff

searches

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

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

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

relevants

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

For more information about this resource and its resources and 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 authenticated Stakeholder.

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

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

userProfile

Returns the details of the authenticated user.

This is applicable to all users.

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 their metadata (for the given authenticated user).

This is applicable to all users.

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

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

cases

Returns a list of all pending cases available in the Inbox of the given authenticated user.

IMPORTANT: This is applicable to all users. It is similar to the casesWithWorkItems resource; however, use this one if you will simply use the cases information without their pending activities.

 

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

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

casesWithWorkitems

Returns a list of all pending cases available in the Inbox of the given authenticated user, with their due pending activities.

IMPORTANT: This is applicable to all users. It is similar to the cases resource. Use this one if you  need the cases' information plus their pending activities (due to performance enhancements).

 

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

[your_bizagi_project_url]/[your_project]/odata/data/casesWithWorkitems

queries

Returns a list of all Queries in the project. It is important to note that all authorization restrictions applicable in the Work Portal are held for services invocations of this resource. This means that only those queries available for a user come up as a result when performing services invocations regarding queries.

 

For more information about this resource and its further resources, refer to Services index and Queries data.

[your_bizagi_project_url]/[your_project]/odata/data/queries

 

The definitions for these resources relate to 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"

   },

   {

     "name": "casesWithWorkitems",

     "kind": "EntitySet",

     "url": "casesWithWorkitems"

   },

   {

     "name": "queries",

     "kind": "EntitySet",

     "url": "queries"

   }

 ]

}