Persona's Relevant processes metadata

<< Click to Display Table of Contents >>

Navigation:  Low-code Process Automation > Studio Cloud - Authoring environment > Bizagi Studio > Bizagi from external applications > Bizagi API > OData RESTful services > Bizagi API examples > Metadata services examples > Personas metadata >

Persona's Relevant processes metadata

Overview

Bizagi features an OData service which handles aspects of the Experience design.

Through the Personas URI, you can handle metadata related to Personas in the project, and when navigating for a specific Persona with its ID you may handle My Stuff, Searches or Relevant processes, as described at Persona's metadata.

This section describes how to query a Persona's Relevant processes.

 

Resource URL

Start with the following URL:

[your_bizagi_project_url]/odata/metadata/Personas([Persona_ID])/relevants

 

Customizations:

•[Persona_ID]: The GUID of a specific Persona as returned when invoking the Persona's metadata.

•[your_bizagi_project_url]: The URL where end users access the Bizagi Work portal.

For Automation Service projects, the URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/odata/metadata/Personas([Persona_ID])/relevants

 

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_SRelevant

 

Returned results include (inside of the value element):

•Name: The 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 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.

Parameters included for each attribute:

oId: A string-based GUID.

oName: The display name.

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

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

For example, use:

[your_bizagi_project_url]/odata/metadata/Personas([Persona_ID])/relevants([relevant_ID])

 

OData_SRelevant2


Last Updated 6/9/2023 3:08:16 AM