My Stuff's actions data

<< Click to Display Table of Contents >>

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

[your_bizagi_project_url]/odata/data/stuff([GUID])/values([value_ID])/actions

 

Consider:

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

[value_ID]: 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 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:

 

OData_SMyStuff3

 

Returned results consider (inside of 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 that specific action.

Parameters: The list of data (attributes) that such action needs in order to run a new one (in this case, to start a case).

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.

 

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])/values([value_ID])/actions([action_ID])

 

OData_SMyStuff4

 

For a given action, you may choose to execute it.

For more information about how to execute actions, refer to Executed actions data