Bizagi features an OData service which handles aspects of the Experience design.
Through the Stakeholders URI, you may handle metadata related to Stakeholders in the project, and when navigating for a specific Stakeholder with its ID you may handle My Stuff, Searches or Relevant processes, as described at Stakeholder's metadata.
This section describes how to query a given Stakeholder's Relevant processes.
Start off from the following URL:
•[stakeholder_ID]: The GUID of a specific stakeholder as returned when invoking the Stakeholder's metadata.
•[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:
While for Bizagi PaaS projects, such 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 consider (inside of the value element):
•Name: The unique name of the Relevant process, as defined in Bizagi Studio.
•DisplayName: The default display name of the Relevant process, as shown to end users in the Work portal.
•@odata.id: The unique URL to access that specific Relevant process.
•Id: A string-based GUID representing the URI of that specific Relevant process.
•Parameters: The list of data (attributes) that such Relevant process needs in order to start a new one.
Such parameters include for each attribute:
oId: A string-based GUID of the attribute.
oName: The display name of the attribute.
oXpath: The full Xpath to that attribute (includes its name).
oType: The type of data of the attribute. For a list of possible values regarding data types in Bizagi, refer to Types of data.
Notice how through the @odata.id property, you can obtain that specific record's detail only, instead of a full list.
For example using: