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 collections as presented in My Stuff.
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 collection of My Stuff, as defined in Bizagi Studio.
•DisplayName: The default display name of the collection of My Stuff, as shown to end users in the Work portal.
•@odata.id: The unique URL to access that specific collection of My Stuff.
•Id: A string-based GUID representing the URI of that specific collection of My Stuff.
•Actions: The list of available actions for that such collection of My Stuff.
Such parameters include for each action:
oId: A string-based GUID of the action.
oName: The name of the action.
oDisplayName: The display name of the action.
oParameters: The list of parameters needed to trigger that new action, which in turn specifies the parameter's ID, name, Xpath and type of data (as per Types of data).
•Template: The list of data (attributes) that such collection of My Stuff uses when displaying its summary through the template.
Such template includes sets of information having:
oName: The name of the attribute.
oXpath: The Xpath to that attribute parting from the process entity.
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:
You may also further navigate and explore specific elements of the My Stuff collections, such as the actions available for each record of those collections.
For example using