My Stuff data

<< Click to Display Table of Contents >>

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

My Stuff data

Overview

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

Through the Stuff URI, you can handle data regarding the My stuff section for the currently logged-in Stakeholder.

 

Resource URL

Start from the following URL:

[your_bizagi_project_url]/odata/data/stuff

 

Customizations:

[your_bizagi_project_url]: Corresponds to 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/stuff

For Automation Service projects, the URL would be:

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

 

Example

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

 

Data_Stuff

 

 

Returned results provide (inside the value element):

Name: The unique name of the collection of My Stuff, as defined in Bizagi Studio.

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

@odata.id: The unique URL to access this specific collection of My Stuff.

Id: A string-based GUID representing the URI of that specific collection of My Stuff.

Actions: The list of available actions for this collection of My Stuff.

Such parameters include for each action:

oId: A string-based GUID of the action.

oName: The name of the action.

oDisplayName: The display name of the action.

oParameters: The list of parameters needed to trigger the new action, which specifies the parameter's ID, name, Xpath and Type of data.

Template: The list of data attributes that the collection of My Stuff uses when displaying its summary through the template.

The 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 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, 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. These properties are described at Properties and querying options.

 

Through the @odata.id property, you can obtain a specific record's detail only, instead of a full list.

For example, use:

[your_bizagi_project_url]/odata/data/stuff([ID_stuff])

 

OData_Stuff2

 

From the above invocation, you can also navigate to the specific values of a particular collection.

For example, use:

[your_bizagi_project_url]/odata/data/stuff([ID_stuff])/values

 

OData_Stuff3

 

Similarly 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/stuff([ID_stuff])/values([ID_value])

 

OData_Stuff4

 

note_pin

To promote best performance, images or uploads in cases are not returned directly by this service.

Instead, the service provides a URL through which you can query the image or upload separately.

To learn more about this option, refer to URLs for Images and Uploads.

 

You can also navigate through and explore specific elements of the My Stuff collections of the logged Stakeholder, such as the actions available for each record of those collections.

For more information about how to navigate to actions which trigger processes from My Stuff, refer to My Stuff's actions data.

 

You can also obtain actions available for the My Stuff collections in general.

For example, use:

[your_bizagi_project_url]/odata/data/stuff([ID_stuff])/actions

 

OData_Stuff8

 

Customizing the returned attributes

If you want to filter or completely change the set of attributes which return information for this invocation, refer to Setting which business information is returned.