Processes metadata

<< Click to Display Table of Contents >>

Navigation:  Bizagi API > 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 may handle metadata related to the Processes of a project.

 

Resource URL

Start off from the following URL:

[your_bizagi_project_url]/odata/metadata/processes

 

Consider:

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

For instance for an on-premise Bizagi project, such URL would be:

https://[your_server]/[your_project]/oauth2/server/token

While for Bizagi Cloud projects, such URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/oauth2/server/token

 

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

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

Parameters: The list of data (attributes) that such process needs in order for a new process to be started.

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.

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

Such template includes sets of information having:

oName: The name of the attribute.

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

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 [your_bizagi_project_url]/odata/metadata/processes([GUID]):

 

OData_ProcessesM2