Stakeholders metadata

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API > OData services > Services index > 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

 

Customizations:

[your_bizagi_project_url]: Corresponds to the URL where end users access the Bizagi Work portal.

For an on-premises Bizagi project, the URL would be:

https://[your_server]/[your_project]/odata/metadata/stakeholders

For Automation Service projects, the URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/odata/metadata/stakeholders

 

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 include (inside  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 the Stakeholder.

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

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

 

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])

 

OData_StakeholdersM2

 

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

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

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

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