Processes metadata

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API > OData services > Services index > Metadata services >

Processes metadata

Overview

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

Through the Processes URI, you can handle metadata related to the Processes of a project.

 

note_pin

This resource is available for all users, regardless of being Stakeholders or not.

Resource URL

Start with the following URL:

[your_bizagi_project_url]/odata/metadata/processes

 

Customizations:

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

For an on-premise Bizagi project, the URL would be:

https://[your_server]/[your_project]/odata/metadata/processes

For Automation Service projects, the URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/odata/metadata/processes

 

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_ProcessesM

 

Returned results include (inside the value element):

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

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

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

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

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

Such 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 of the attribute. For a list of possible data types in Bizagi, refer to Types of data.

Template: The list of data (attributes) that the process uses when displaying its summary through the template.

Such template includes sets of information having:

oName: The name.

oXpath: The Xpath to that attribute starting from the process entity.

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/processes([process_ID])

 

OData_ProcessesM2

 

You can navigate to and explore specific elements deriving from Processes, such as the actions available for those processes.

For example, use:

[your_bizagi_project_url]/odata/metadata/processes([process_ID])/actions

 

OData_MetadataActionsFromProc