Stakeholders data

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API > OData services > 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 may handle data related to Stakeholders in the project.

 

Resource URL

Start off from the following URL:

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

 

Consider:

[your_company]: The name of your company.

[your_project]: The name of your Bizagi project. Recall that for environments other than the production environment, the project includes a suffix referencing the given environment.

 

Example

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

 

OData_DStakeholders

 

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.