My Stuff data

<< Click to Display Table of Contents >>

Navigation:  Bizagi API > 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 may handle data regarding the My stuff section for the currently logged on Stakeholder.

 

Resource URL

Start off from the following URL:

[your_bizagi_project_url]/odata/data/stuff

 

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

 

Example

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

 

Data_Stuff

 

 

Returned results consider (inside of 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 that 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 that such 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 that new action, which in turn specifies the parameter's ID, name, Xpath and type of data (as per Types of data).

Template: The list of data (attributes) that such collection of My Stuff 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/data/stuff([GUID]):

 

OData_Stuff2

 

Parting from the above invocation, you may also navigate to the specific values of a particular collection.

For example using [your_bizagi_project_url]/odata/data/stuff([GUID])/values:

 

OData_Stuff3

 

And similarly through the @odata.id property, obtain a specific record's detail only, instead of a full list.

For example using [your_bizagi_project_url]/odata/data/stuff([GUID])/values([value_ID]):

 

OData_Stuff4

 

note_pin

Records having images or files are not returned per sé by this service.

Instead, an URL is provided to query such image:

 

OData_Stuff7

 

Consider that in this new invocation you may also use width and height as query parameters.

 

You may also further navigate 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 continue to navigate to actions which trigger processes from My Stuff, refer to My Stuff's actions data.

 

Customizing the returned attributes

In case 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.