Stakeholders data

<< Click to Display Table of Contents >>

Navigation:  Bizagi API > Services index > Data services >

Stakeholders data

Overview

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

Through the Stakeholders URI, you can handle data related to Stakeholders in the project.

 

Resource URL

Start with the following URL:

[your_bizagi_project_url]/odata/data/stakeholders

 

Customizations:

[your_bizagi_project_url]: 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/data/stakeholders

For Automation Service projects, the URL would be:

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

 

Example

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

 

OData_DStakeholders

 

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.