Stakeholders metadata

<< Click to Display Table of Contents >>

Navigation:  Bizagi API > Metadata services >

Stakeholders metadata

Overview

Bizagi features an OData service which handles aspects of the Experience design, as described at Metadata services.

Through the Stakeholders URI, you may handle metadata related to Stakeholders in the project.

 

Resource URL

Start off from the following URL:

[your_bizagi_project_url]/odata/metadata/stakeholders

 

Consider:

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

https://[your_server]/[your_project]/oauth2/server/token

While for Bizagi Cloud projects, such URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/oauth2/server/token

 

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_StakeholdersM

 

Returned results consider (inside of the value element):

Name: The unique name of the Stakeholder, as defined in Bizagi Studio.

DisplayName: The default display name of the Stakeholder, as shown to end users in the Work portal.

@odata.id: The unique URL to access that specific Stakeholder.

Id: A string-based GUID representing the URI of that specific Stakeholder.

IconName: The name of the icon used to represent that specific Stakeholder.

 

note_pin

In addition to the above, for every set of results returned by the OData services, the successful response includes a set of standard properties which are preceded by the @ sign. Such properties are described at Properties and querying options.

 

Notice how through the @odata.id property, you can obtain that specific record's detail only, instead of a full list.

For example using [your_bizagi_project_url]/odata/metadata/stakeholders([GUID]):

 

OData_StakeholdersM2

 

You may also further navigate and explore specific elements of a given Stakeholder, such as the My Stuff collections, Searches, or Relevant processes.

For more information about how to continue to navigate to My Stuff, refer to Stakeholder's My Stuff metadata.

For more information about how to continue to navigate to Searches, refer to Stakeholder's Searches metadata.

For more information about how to continue to navigate to Relevant processes, refer to Stakeholder's Relevant processes metadata.