Package org.bonitasoft.web.client.api

Interface BdmApi

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

  • Method Details

    • getBdm

      Bdm getBdm()
      Get the BDM Returns the current BDM. Make this call to get the status the BDM.
      Returns:
      Bdm

    • getBdmWithHttpInfo

      ApiResponse<Bdm> getBdmWithHttpInfo()
      Get the BDM Similar to getBdm but it also returns the http response headers . Returns the current BDM. Make this call to get the status the BDM.
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • installBDM

      @Deprecated void installBDM(BDMInstallRequest bdMInstallRequest)
      Deprecated.
      Install a BDM Install a BDM Warning: as of 9.0.0, importing a BDM using this API is deprecated.
      Parameters:
      bdMInstallRequest - (optional)

    • installBDMWithHttpInfo

      @Deprecated ApiResponse<Void> installBDMWithHttpInfo(BDMInstallRequest bdMInstallRequest)
      Deprecated.
      Install a BDM Similar to installBDM but it also returns the http response headers . Install a BDM Warning: as of 9.0.0, importing a BDM using this API is deprecated.
      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

    • searchBusinessDataAttributeByIdWithHttpInfo

      ApiResponse<BusinessData> searchBusinessDataAttributeByIdWithHttpInfo(String businessDataType, String persistenceId, String attributeName)
      Finds business data attribute by id Similar to searchBusinessDataAttributeById but it also returns the http response headers . 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:
      A ApiResponse that wraps the response boyd and the http headers.

    • 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

    • searchBusinessDataByIdWithHttpInfo

      ApiResponse<BusinessData> searchBusinessDataByIdWithHttpInfo(String businessDataType, String persistenceId)
      Finds business data by Id Similar to searchBusinessDataById but it also returns the http response headers . Finds business data specified by its identifier.
      Parameters:
      businessDataType - Business Data Type (required)
      persistenceId - Business data ID (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • 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>

    • searchBusinessDataByIdsWithHttpInfo

      ApiResponse<List<BusinessData>> searchBusinessDataByIdsWithHttpInfo(String businessDataType, String ids)
      Finds business data By Ids Similar to searchBusinessDataByIds but it also returns the http response headers . Finds business data specified by their identifiers.
      Parameters:
      businessDataType - Business Data Type (required)
      ids - list of persistenceIds (comma separated) (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchBusinessDataByIds

      List<BusinessData> searchBusinessDataByIds(String businessDataType, BdmApi.SearchBusinessDataByIdsQueryParams 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>

    • searchBusinessDataByIdsWithHttpInfo

      ApiResponse<List<BusinessData>> searchBusinessDataByIdsWithHttpInfo(String businessDataType, BdmApi.SearchBusinessDataByIdsQueryParams queryParams)
      Finds business data By Ids Finds business data specified by their identifiers. Note, this is equivalent to the other searchBusinessDataByIds 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:

      • ids - list of persistenceIds (comma separated) (required)
      Returns:
      List<BusinessData>

    • uploadFile

      String uploadFile(File file)
      Upload a file Upload file. **NOTE:** If this file is a BDM zip, to do this, Maintenance mode needs to be enabled. In Enterprise editions, if you have an access control file installed, you need to delete it before installing or updating your BDM.
      Parameters:
      file - (optional)
      Returns:
      String

    • uploadFileWithHttpInfo

      ApiResponse<String> uploadFileWithHttpInfo(File file)
      Upload a file Similar to uploadFile but it also returns the http response headers . Upload file. **NOTE:** If this file is a BDM zip, to do this, Maintenance mode needs to be enabled. In Enterprise editions, if you have an access control file installed, you need to delete it before installing or updating your BDM.
      Parameters:
      file - (optional)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.