Stakeholder's Searches metadata

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API > OData services > Services index > Metadata services > Stakeholders metadata >

Stakeholder's Searches metadata

Overview

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

Through the Stakeholders URI, you can handle metadata related to Stakeholders in the project, and when navigating for a specific Stakeholder with its ID you may handle My Stuff, Searches or Relevant processes, as described at Stakeholder's metadata.

This section describes how to query a Stakeholder's Searches.

 

Resource URL

Start with the following URL:

[your_bizagi_project_url]/odata/metadata/stakeholders([stakeholder_ID])/searches

 

Customizations:

[stakeholder_ID]: The GUID of a specific stakeholder as returned when invoking the Stakeholder's metadata.

[your_bizagi_project_url]: The URL where end users access the Bizagi Work portal.

For an on-premise Bizagi project, the URL would be:

https://[your_server]/[your_project]/odata/metadata/stakeholders([stakeholder_ID])/searches

For Automation Service projects, the URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/odata/metadata/stakeholders([stakeholder_ID])/searches

 

note_pin

This resource is available through an HTTP GET action.

 

Example

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

 

OData_SSearches

 

Returned results include (inside the value element):

Name: The unique name of the search, as defined in Bizagi Studio.

DisplayName: The default display name of the search, as shown to end users in the Work portal.

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

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

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

Parameters included for each attribute:

oId: A string-based GUID.

oName: The display name.

oXpath: The full Xpath to that attribute (including its name).

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

Actions: The list of available actions for that such collection of My Stuff.

Parameters included for each action:

oId: A string-based GUID.

oName: The name.

oDisplayName: The display name of the action.

oParameters: The list of parameters needed to trigger a 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 the search uses when displaying its results.

The template includes sets of information for each attribute:

oName: The name of the attribute.

oXpath: The Xpath starting from the process entity.

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

 

note_pin

Every set of results returned by the OData services includes a set of standard properties which are preceded by the @ sign. These properties are described at Properties and querying options.

 

Through the @odata.id property, you can obtain a specific record's details only, instead of a full list.

For example, use:

[your_bizagi_project_url]/odata/metadata/stakeholders([stakeholder_ID])/searches([search_ID])

 

OData_SSearches2

 

 

You can also navigate to and explore specific elements deriving from such Searches, such as the actions available for a record returned by that search.

For example, use:

[your_bizagi_project_url]/odata/metadata/stakeholders([stakeholder_ID])/searches([search_ID])/actions

 

OData_MetadataActionsFromSearch