Queries data

<< Click to Display Table of Contents >>

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

Queries data

Overview

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

Through the Queries URI, you may handle data related to Query forms provided to Stakeholders.

 

Remember to make sure that you have set up Queries on your project, otherwise the following features may result in errors or empty responses.

To check if you have set up Queries on your project, navigate to the Expert view, Entities option, and find the Queries leaf on the tree which is under the Application > App > Queries path. When you click that option, on the main panel you should see your created Queries or you may add a new one.

For further information about Queries, refer to this article.

 

OData_Queries07

 

Resource URL

Start off from the following URL:

[your_bizagi_project_url]/odata/data/queries

 

Consider:

[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]/odata/data/queries

While for Automation Service projects, such URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/odata/data/queries

 

Example

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

Notice how the response of the HTTP request matches the Queries shown in the previous image.

 

OData_Queries01

 

 

Returned results consider (inside of the value element):

DisplayName: The default display name of the Query.

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

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

 

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/queries([ID_query]):

 

OData_Queries02

 

For a given query, you may further execute that requests and explore results.

For more information about how to continue to execute queries and navigate with their results, refer to Execute Queries from requests.

 

Notice you may also obtain query parameters for Queries in general.

For example using:

[your_bizagi_project_url]/odata/data/queries([ID_query])/parameters

 

OData_Queries03

 

Notice, by reviewing the image below, that the results obtained from the service invocation correspond to the controls added into that Query.

 

OData_Queries08

 

You may also want to drill down into a given paramater.

For example using:

[your_bizagi_project_url]/odata/data/queries([ID_query])/parameters([ID_Param])

This service invocation will return further information regarding a specific parameter of a given query.

 

Customizing the returned attributes

In case you want to filter or completely change the set of information returned for this service invocation, refer to Setting which business information is returned.