Processes data

<< Click to Display Table of Contents >>

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

Processes data

Overview

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

Through the Processes URI, you can handle data related to the Processes of a user.

 

note_pin

This resource is available for all users, not just Stakeholders.

 

Resource URL

Start with the following URL:

[your_bizagi_project_url]/odata/data/processes

 

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

For Automation Service projects, the URL would be:

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

 

Example

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

 

OData_DProcesses1

 

Returned results include (inside the value element):

Name: The unique name of the process as available for that user as defined in Bizagi Studio.

DisplayName: The default display name of the process as available for that user and as shown to end users in the Work portal.

@odata.id: The unique URL to access that specific process as available for that user.

Id: A string-based GUID representing the URI of that specific process as available for that user.

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

The parameters included for each attribute:

oId: A string-based GUID.

oName: The display name.

oXpath: The full Xpath (includes its name).

oType: The data type 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 the process uses when displaying its summary through the template.

Each template includes sets of information having:

oName: The name of the attribute.

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

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

For example, use:

[your_bizagi_project_url]/odata/data/processes([ID_process])

 

OData_DProcesses2

 

For a given process, you can fetch the list of cases that the user has.

For more information about how to continue exploring cases of a given process, refer to Cases from processes data.

 

Similarly and for a given process, you can send parameters and start a new case.

For more information about how to launch processes, refer to Processes startup data.

 

You can also obtain actions available for the process entity of Processes in general.

For example, use:

[your_bizagi_project_url]/odata/data/processes([ID_process])/actions

 

OData_Processes