Stakeholder's My Stuff metadata

<< Click to Display Table of Contents >>

Navigation:  Bizagi API > Services index > Metadata services > Stakeholders metadata >

Stakeholder's My Stuff metadata

Overview

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 collections as presented in My Stuff.

 

Resource URL

Start with the following URL:

[your_bizagi_project_url]/odata/metadata/stakeholders([stakeholder_ID])/stuff

 

Customizations:

[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:

https://[your_server]/[your_project]/odata/metadata/stakeholders([stakeholder_ID])/stuff

For Automation Service projects, the URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/odata/metadata/stakeholders([stakeholder_ID])/stuff

 

note_pin

This resource is available through an HTTP GET action.

 

Example

The following image illustrates how you can send an HTTP GET for this resource:

 

OData_SMyStuff

 

Returned results include (inside 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 the collection of My Stuff.

Id: A string-based GUID representing the URI of the collection of My Stuff.

Actions: The list of available actions for the collection of My Stuff.

The parameters included for each action:

oId: A string-based GUID.

oName: The name.

oDisplayName: The display name.

oParameters: The list of parameters needed to trigger a 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 a collection of My Stuff uses when displaying its summary through the template.

The template includes for each attribute:

oName: The name.

oXpath: The Xpath to the attribute from the process entity.

oType: The data type. For a list of possible data types in Bizagi, refer to Types of data.

 

note_pin

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:

[your_bizagi_project_url]/odata/metadata/stakeholders([stakeholder_ID])/stuff([stuff_ID])

 

OData_SMyStuff2

 

 

You can navigate to and explore specific elements of the My Stuff collections, such as the actions available for each record of the collections.

For example, use:

[your_bizagi_project_url]/odata/metadata/stakeholders([stakeholder_ID])/stuff([stuff_ID])/actions

 

OData_MetadataActions