Package org.bonitasoft.web.client.api

Interface BdmApi

All Superinterfaces:

ApiClient.Api

public interface BdmApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BdmApi.SearchBusinessDataByIdsQueryParams	A convenience class for generating query parameters for the searchBusinessDataByIds method in a fluent style.

Method Summary

Modifier and Type	Method	Description
Bdm	getBdm()	Get the BDM Returns the current BDM.
void	installBDM(BDMInstallRequest bdMInstallRequest)	Install a BDM Install a BDM
BusinessData	searchBusinessDataAttributeById(String businessDataType, String persistenceId, String attributeName)	Finds business data attribute by id Gets the business data attribute of business data according to its identifier and attribute name.
BusinessData	searchBusinessDataById(String businessDataType, String persistenceId)	Finds business data by Id Finds business data specified by its identifier.
List<BusinessData>	searchBusinessDataByIds(String businessDataType, String ids)	Finds business data By Ids Finds business data specified by their identifiers.
List<BusinessData>	searchBusinessDataByIds(String businessDataType, Map<String,Object> queryParams)	Finds business data By Ids Finds business data specified by their identifiers.
String	uploadBDM(File file)	Upload a BDM Upload BDM.

Method Detail

getBdm

Bdm getBdm()

Get the BDM Returns the current BDM. Make this call to get the status the BDM.

Returns:

Bdm

installBDM

void installBDM(BDMInstallRequest bdMInstallRequest)

Install a BDM Install a BDM

Parameters:

bdMInstallRequest - (optional)

searchBusinessDataAttributeById

BusinessData searchBusinessDataAttributeById(String businessDataType,
                                             String persistenceId,
                                             String attributeName)

Finds business data attribute by id Gets the business data attribute of business data according to its identifier and attribute name. Request url.

Parameters:

businessDataType - Business Data Type (required)

persistenceId - Business data ID (required)

attributeName - Business data attribute name (required)

Returns:

BusinessData

searchBusinessDataById

BusinessData searchBusinessDataById(String businessDataType,
                                    String persistenceId)

Finds business data by Id Finds business data specified by its identifier.

Parameters:

businessDataType - Business Data Type (required)

persistenceId - Business data ID (required)

Returns:

BusinessData

searchBusinessDataByIds

List<BusinessData> searchBusinessDataByIds(String businessDataType,
                                           String ids)

Finds business data By Ids Finds business data specified by their identifiers.

Parameters:

businessDataType - Business Data Type (required)

ids - list of persistenceIds (comma separated) (required)

Returns:

List<BusinessData>

searchBusinessDataByIds

List<BusinessData> searchBusinessDataByIds(String businessDataType,
                                           Map<String,Object> queryParams)

Finds business data By Ids Finds business data specified by their identifiers. Note, this is equivalent to the other searchBusinessDataByIds 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 BdmApi.SearchBusinessDataByIdsQueryParams 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:

• ids - list of persistenceIds (comma separated) (required)

Returns:

List<BusinessData>

uploadBDM

String uploadBDM(File file)

Upload a BDM Upload BDM. **NOTE:** To do this, your tenant services need to be paused. In Enterprise editions, if you have an access control file installed on your tenant, you need to delete it before installing or updating your BDM.

Parameters:

file - (optional)

Returns:

String