Package org.bonitasoft.web.client.api

Interface BusinessDataQueryApi

All Superinterfaces:

ApiClient.Api

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.12.0")
public interface BusinessDataQueryApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BusinessDataQueryApi.SearchBusinessDataQueryParams	A convenience class for generating query parameters for the searchBusinessData method in a fluent style.

Method Summary

Modifier and Type	Method	Description
List<Object>	searchBusinessData(String businessDataType, String q, Integer p, Integer c, List<String> f)	Finds Business Data Finds Business Data with pagination params and filters by calling a `Named Query`.
List<Object>	searchBusinessData(String businessDataType, BusinessDataQueryApi.SearchBusinessDataQueryParams queryParams)	Finds Business Data Finds Business Data with pagination params and filters by calling a `Named Query`.
ApiResponse<List<Object>>	searchBusinessDataWithHttpInfo(String businessDataType, String q, Integer p, Integer c, List<String> f)	Finds Business Data Similar to searchBusinessData but it also returns the http response headers .
ApiResponse<List<Object>>	searchBusinessDataWithHttpInfo(String businessDataType, BusinessDataQueryApi.SearchBusinessDataQueryParams queryParams)	Finds Business Data Finds Business Data with pagination params and filters by calling a `Named Query`.

Method Details

searchBusinessData

List<Object> searchBusinessData(String businessDataType,
 String q,
 Integer p,
 Integer c,
 List<String> f)

Finds Business Data Finds Business Data with pagination params and filters by calling a `Named Query`. The business data query REST API resource is used to call a default or custom business data query. It is available from version 6.5. **Data parameters**: * businessDataType - the fully-qualified business data type name * q=queryName - the query name * p=0 - the page number * c=10 - the maximum number of results in the page * f=parameter=value - sets the parameter value according to business data query parameters defined in Bonita Studio For a Boolean parameter, the accepted values are `true` or `false`. By default, for a Date parameter can use the following formats: * yyyy-MM-dd * HH:mm:ss * yyyy-MM-dd HH:mm:ss * yyyy-MM-dd'T'HH:mm:ss * yyyy-MM-dd'T'HH:mm:ss.SSS

Parameters:

businessDataType - Business Data Type (required)

q - Named query to use (required)

p - index of the page to display (required)

c - maximum number of elements to retrieve (required)

f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)

Returns:

List<Object>

searchBusinessDataWithHttpInfo

ApiResponse<List<Object>> searchBusinessDataWithHttpInfo(String businessDataType,
 String q,
 Integer p,
 Integer c,
 List<String> f)

Finds Business Data Similar to searchBusinessData but it also returns the http response headers . Finds Business Data with pagination params and filters by calling a `Named Query`. The business data query REST API resource is used to call a default or custom business data query. It is available from version 6.5. **Data parameters**: * businessDataType - the fully-qualified business data type name * q=queryName - the query name * p=0 - the page number * c=10 - the maximum number of results in the page * f=parameter=value - sets the parameter value according to business data query parameters defined in Bonita Studio For a Boolean parameter, the accepted values are `true` or `false`. By default, for a Date parameter can use the following formats: * yyyy-MM-dd * HH:mm:ss * yyyy-MM-dd HH:mm:ss * yyyy-MM-dd'T'HH:mm:ss * yyyy-MM-dd'T'HH:mm:ss.SSS

Parameters:

businessDataType - Business Data Type (required)

q - Named query to use (required)

p - index of the page to display (required)

c - maximum number of elements to retrieve (required)

f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)

Returns:

A ApiResponse that wraps the response boyd and the http headers.

searchBusinessData

List<Object> searchBusinessData(String businessDataType,
 BusinessDataQueryApi.SearchBusinessDataQueryParams queryParams)

Finds Business Data Finds Business Data with pagination params and filters by calling a `Named Query`. The business data query REST API resource is used to call a default or custom business data query. It is available from version 6.5. **Data parameters**: * businessDataType - the fully-qualified business data type name * q=queryName - the query name * p=0 - the page number * c=10 - the maximum number of results in the page * f=parameter=value - sets the parameter value according to business data query parameters defined in Bonita Studio For a Boolean parameter, the accepted values are `true` or `false`. By default, for a Date parameter can use the following formats: * yyyy-MM-dd * HH:mm:ss * yyyy-MM-dd HH:mm:ss * yyyy-MM-dd'T'HH:mm:ss * yyyy-MM-dd'T'HH:mm:ss.SSS Note, this is equivalent to the other searchBusinessData method, but with the query parameters collected into a single Map parameter. This is convenient for services with optional query parameters, especially when used with the BusinessDataQueryApi.SearchBusinessDataQueryParams class that allows for building up this map in a fluent style.

Parameters:

businessDataType - Business Data Type (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• q - Named query to use (required)
• p - index of the page to display (required)
• c - maximum number of elements to retrieve (required)
• f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)

Returns:

List<Object>

searchBusinessDataWithHttpInfo

ApiResponse<List<Object>> searchBusinessDataWithHttpInfo(String businessDataType,
 BusinessDataQueryApi.SearchBusinessDataQueryParams queryParams)

Finds Business Data Finds Business Data with pagination params and filters by calling a `Named Query`. The business data query REST API resource is used to call a default or custom business data query. It is available from version 6.5. **Data parameters**: * businessDataType - the fully-qualified business data type name * q=queryName - the query name * p=0 - the page number * c=10 - the maximum number of results in the page * f=parameter=value - sets the parameter value according to business data query parameters defined in Bonita Studio For a Boolean parameter, the accepted values are `true` or `false`. By default, for a Date parameter can use the following formats: * yyyy-MM-dd * HH:mm:ss * yyyy-MM-dd HH:mm:ss * yyyy-MM-dd'T'HH:mm:ss * yyyy-MM-dd'T'HH:mm:ss.SSS Note, this is equivalent to the other searchBusinessData that receives the query parameters as a map, but this one also exposes the Http response headers

Parameters:

businessDataType - Business Data Type (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• q - Named query to use (required)
• p - index of the page to display (required)
• c - maximum number of elements to retrieve (required)
• f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)

Returns:

List<Object>