Bizagi features an OData service which handles aspects of the Experience design, as described at Metadata services.
Through the Processes URI, you can handle metadata related to the Processes of a project.
This resource is available for all users, regardless of being Stakeholders or not.
Start with the following URL:
•[your_bizagi_project_url]: The URL where end users access the Bizagi Work portal.
For an on-premise Bizagi project, the URL would be:
For Automation Service projects, the URL would be:
This resource is available through an HTTP GET action.
The following image illustrates how you can send an HTTP GET for this resource:
Returned results include (inside the value element):
•Name: The unique name of the process, as defined in Bizagi Studio.
•DisplayName: The default display name of the process, as shown to end users in the Work portal.
•@odata.id: The unique URL to access the process.
•Id: A string-based GUID representing the URI of the process.
•Parameters: The list of data (attributes) that the process needs to start a new process.
Such parameters included for each attribute:
oId: A string-based GUID.
oName: The display name.
oXpath: The full Xpath to that attribute (includes its name).
oType: The data type of the attribute. For a list of possible data types in Bizagi, refer to Types of data.
•Template: The list of data (attributes) that the process uses when displaying its summary through the template.
Such template includes sets of information having:
oName: The name.
oXpath: The Xpath to that attribute starting from the process entity.
oType: The data type. For a list of possible data types in Bizagi, refer to Types of data.
Every set of results returned by the OData services includes a set of standard properties which are preceded by the @ sign. These properties are described at Properties and querying options.
Through the @odata.id property, you can obtain a specific record's details only, instead of a full list.
For example, use:
You can navigate to and explore specific elements deriving from Processes, such as the actions available for those processes.
For example, use: