Metadata services

<< Click to Display Table of Contents >>

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

Metadata 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 model (metadata). as described at Bizagi API.

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

 

Important

The Metadata services in Bizagi do not consider the context and information relevant to a specific user (Stakeholder), even though an authenticated request is made.

Such service does not return business information per sé.

 

note_pin

Resources of the Metadata services are available through HTTP GET actions.

 

Metadata services base URL

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

https://[your_company].bizagi.com/[your_project]/odata/metadata

 

Consider:

[your_company]: The name of your company.

[your_project]: The name of your Bizagi project. Recall that for environments other than the production environment, the project includes a suffix referencing the given environment.

 

Resources in Metadata services

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

 

Resource

Description

URL example

Processes

Returns a list of all processes.

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

https://[your_company].bizagi.com/[your_project]/odata/metadata/processes

Stakeholders

Returns a list of all Stakeholders available.

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

https://[your_company].bizagi.com/[your_project]/odata/metadata/stakeholders

getProject

Returns the single details of the current project.

For more information about this resource, refer to Project metadata.

https://[your_company].bizagi.com/[your_project]/odata/metadata/getProject

 

 

Notice that these resources' definition is provided for an HTTP GET action with the base URL (https://[your_company].bizagi.com/[your_project]/odata/metadata):

{

 "@odata.context": "http://[your_company].bizagi.com/[your_project]/odata/metadata/$metadata",

 "value": [

   {

     "name": "stakeholders",

     "kind": "EntitySet",

     "url": "stakeholders"

   },

   {

     "name": "processes",

     "kind": "EntitySet",

     "url": "processes"

   }

 ]

}