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é.
|
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:
[your_bizagi_project_url]/odata/metadata
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]/odata/metadata
While for Bizagi PaaS projects, such URL would be:
https://[project_environment]-[your_project]-[your_company].bizagi.com/odata/metadata
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. |
[your_bizagi_project_url]/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. |
[your_bizagi_project_url]/odata/metadata/stakeholders |
getProject |
Returns the single details of the current project. For more information about this resource, refer to Project metadata. |
[your_bizagi_project_url]/odata/metadata/getProject |
Notice that these resources' definition is provided for an HTTP GET action with the base URL ([your_bizagi_project_url]/odata/metadata):
{
"@odata.context": "[your_bizagi_project_url]/odata/metadata/$metadata",
"value": [
{
"name": "stakeholders",
"kind": "EntitySet",
"url": "stakeholders"
},
{
"name": "processes",
"kind": "EntitySet",
"url": "processes"
}
]
}