Relevant to me data

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API > OData services > Data services >

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 may handle data related to the Relevant to me section of Stakeholders.

 

Resource URL

Start off from the following URL:

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

 

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_DRelevants1

 

Returned results consider (inside of 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 that specific Relevant process.

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

Parameters: The list of data (attributes) that such Relevant process needs in order to start a new one.

Such parameters include for each attribute:

oId: A string-based GUID of the attribute.

oName: The display name of the attribute.

oXpath: The full Xpath to that attribute (includes its name).

oType: The type of data of the attribute. For a list of possible values regarding data types in Bizagi, refer to Types of data.

 

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:

https://[your_company].bizagi.com/[your_project]/odata/data/relevants([GUID]):

 

OData_DRelevants2

 

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

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