Setting which business information is returned

<< Click to Display Table of Contents >>

Navigation:  Bizagi API > Data services >

Setting which business information is returned

Overview

When invoking OData services, especifically while fetching business information from the Data services, you may choose which attributes are returned.

This configuration is completely optional, and it applies to:

1. MyStuff invocations.

2. Searches invocations

3. Processes data (cases) invocations.

 

Note that by default, returned attributes are those which have been set in the default template that shows information for an entity.

You may override such definition, by setting for each entity which information will be available for OData invocations.

 

Configuring exposed attributes

In order to do so, locate the Entity holding that set of information which you want to explicitly include or exclude.

Go to the Expert view and into the Entities module for this, and right click on your chosen entity.

Click the OData exposed attributes option:

 

OData_Studio1

 

On the opening window, click Customize to change the definition of the attributes which are returned so that not all of them are necessarily considered.

 

OData_Studio2

 

Unmark those attributes in the left panel which you want to rule out of the business information returned by OData services:

 

OData_Studio3

 

Notice that the right panel will automatically reflect Selected Data and the attributes which are chosen.

Click Ok when done.

 

Example

The following example shows how this configuration is applicable to a search of the Experience Design features.

A search called Search Requests is set to rely on the SimplePurchaseRequest entity as shown below:

 

OData_Studio6

 

Therefore, in order to narrow down and specify exactly which bits of business information are returned when fetching information from the SimplePurchaseRequest entity, you may use the OData exposed attributes option.

In this case, attributes have been customized for the previous search as shown in Studio:

 

OData_Studio4

 

When invoking the Search Requests search, note that the attributes to be returned match the customization set above:

 

OData_Studio5