Relevant to me data

<< Click to Display Table of Contents >>

Navigation:  Application integration > Bizagi RESTful API > Bizagi API examples > Data services examples >

Relevant to me data

Overview

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

Through the Relevants URI, you can handle data related to the Relevant to me section of Stakeholders.

 

Resource URL

Start with the following URL:

[your_bizagi_project_url]/odata/data/relevants

 

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/relevants

For Automation Service projects, the URL would be:

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

 

Example

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

 

OData_DRelevants1

 

Returned results include (inside the value element):

•Name: The unique name of the Relevant process, as defined in Bizagi Studio.

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

•@odata.id: The unique URL to access the Relevant process.

•Id: A string-based GUID representing the URI of the Relevant process.

•Parameters: The list of data (attributes) that the Relevant process needs to start a new one instance.

These parameters are included for each attribute:

oId: A string-based GUID.

oName: The display name.

oXpath: The full Xpath (includes its name).

oType: The data type. For a list of possible values regarding 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 tahat specific record's detail only, instead of a full list.

For example, use:

[your_bizagi_project_url]/odata/data/relevants([ID_relevant])

 

OData_DRelevants2

 

For a given Relevant process, you can send out parameters and start a new case.

For more information about how to launch processes available from Relevant to me, refer to Relevant processes startup data.