Searches data

<< Click to Display Table of Contents >>

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

Searches data

Overview

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

Through the Searches URI, you may handle data related to searches provided to Stakeholders.

 

Resource URL

Start off from the following URL:

https://[your_company].bizagi.com/[your_project]/odata/data/searches

 

Consider:

[your_company]: The name of your company.

[your_project]: The name of your Bizagi project. Recall that for environments other than the production environment, the project includes a suffix referencing the given environment.

 

Example

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

 

OData_DSearches1

 

 

Returned results consider (inside of the value element):

Name: The unique name of the search for that Stakeholder.

DisplayName: The default display name of the search, as shown to the Stakeholder.

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

Id: A string-based GUID representing the URI of that specific search.

Parameters: The list of data (attributes) that such search needs in order to run a new one.

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.

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 search uses when displaying the matching records.

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 https://[your_company].bizagi.com/[your_project]/odata/data/searches([GUID]):

 

OData_DSearches2

 

For a given search, you may further execute that search and explore results (for instance to execute actions available for a result).

For more information about how to continue to execute searches and navigate with their results, refer to Searches execution and results 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.