Bizagi features an OData service which handles aspects of the Experience design.
Through the Stakeholders URI, you can 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 Stakeholder's Relevant processes.
Start with the following URL:
•[stakeholder_ID]: The GUID of a specific stakeholder as returned when invoking the Stakeholder's metadata.
•[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 of the value element):
•Name: The 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 URL to access the Relevant process.
•Id: A string-based GUID representing the URI of the Relevant process.
•Parameters: The list of data (attributes) that the Relevant process needs to start a new one.
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. 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: