My Stuff's actions 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 >

My Stuff's actions data

Overview

Bizagi features an OData service which handles aspects of the Experience design.

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

This section describes how to query and execute a given action from data in My Stuff.

 

note_pin

Actions considered by this service are solely those which trigger new processes.

Actions which execute rules or launch forms are not supported.

 

Resource URL

Start from the following URL:

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

 

Customization:

[ID_stuff]: The GUID of a specific collection of My stuff as returned when invoking the My Stuff's data.

[ID_value]: The ID of a specific item of a My stuff collection, as returned when obtaining the My Stuff's data.

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

For Automation Service projects, the URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/stuff([ID_stuff])/values([ID_value])/actions

 

Example

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

 

OData_SMyStuff3

 

Returned results include (inside the value element):

Name: The unique name of the action.

DisplayName: The default display name of the action, as shown for a record.

@odata.id: The unique URL to access that specific action.

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

Parameters: The list of data (attributes) that the action needs in this case, to start a case.

The parameters included for each attribute:

oId: A string-based GUID.

oName: The display name.

oXpath: The full Xpath (including the attribute's name).

oType: The type of data of the attribute. For a list of possible data types in Bizagi, refer to Types of data.

 

note_pin

In addition, every set of results returned by the OData services includes a set of standard properties which are preceded by the @ sign. The 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])/values([ID_valor])/actions([ID_action])

 

OData_SMyStuff4

 

You can choose to execute any action. For more information  refer to Executed actions data