Package org.bonitasoft.web.client.api

Interface BusinessDataOperationsApi

All Superinterfaces:

ApiClient.Api

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

Method Summary

Modifier and Type	Method	Description
void	deleteBusinessData(String businessDataType, BigDecimal persistenceId)	Delete an existing Business Data !
ApiResponse<Void>	deleteBusinessDataWithHttpInfo(String businessDataType, BigDecimal persistenceId)	Delete an existing Business Data Similar to deleteBusinessData but it also returns the http response headers . !
BusinessDataImportResult	importBusinessData(String businessDataType, File dataset)	Import Business Data by bulk !
ApiResponse<BusinessDataImportResult>	importBusinessDataWithHttpInfo(String businessDataType, File dataset)	Import Business Data by bulk Similar to importBusinessData but it also returns the http response headers . !
BusinessDataCreationResult	insertBusinessData(String businessDataType, Object body)	Create new Business Data !
ApiResponse<BusinessDataCreationResult>	insertBusinessDataWithHttpInfo(String businessDataType, Object body)	Create new Business Data Similar to insertBusinessData but it also returns the http response headers . !
BusinessDataUpdateResult	updateBusinessData(String businessDataType, BigDecimal persistenceId, Object body)	Update an existing Business Data !
ApiResponse<BusinessDataUpdateResult>	updateBusinessDataWithHttpInfo(String businessDataType, BigDecimal persistenceId, Object body)	Update an existing Business Data Similar to updateBusinessData but it also returns the http response headers . !

Method Details

deleteBusinessData

void deleteBusinessData(String businessDataType,
 BigDecimal persistenceId)

Delete an existing Business Data  Delete an existing Business Data.

Parameters:

businessDataType - The Business Data type to delete (required)

persistenceId - Business data ID to delete (required)

deleteBusinessDataWithHttpInfo

ApiResponse<Void> deleteBusinessDataWithHttpInfo(String businessDataType,
 BigDecimal persistenceId)

Delete an existing Business Data Similar to deleteBusinessData but it also returns the http response headers .  Delete an existing Business Data.

Parameters:

businessDataType - The Business Data type to delete (required)

persistenceId - Business data ID to delete (required)

importBusinessData

BusinessDataImportResult importBusinessData(String businessDataType,
 File dataset)

Import Business Data by bulk  Allows to import business data in bulk by uploading a file containing the data, in CSV format. Example CSV file content: ```csv firstName,lastName,department, dptReference, dateOfBirth, dateOfBirthWithTime, meetingDateAndTimeWithTimezone, otherDateAndTimeWithTimezone \"John\",\"Doe\",\"Engineering\", 14, \"1907-05-26\", \"1907-05-26T01:59:42\", \"2025-11-29T10:15:00+01:00\", \"2025-11-29T10:15:00Z\" \"Jane\",\"Smith\", \"Marketing\", 17, \"1977-03-24\", \"1977-03-24T17:40:00\", \"2025-07-19T09:00:00+01:00\", \"2025-07-19T09:00:00Z\" ``` Field separator can be comma (`,`) or semicolon (`;`). Space characters around the separator will be ignored (trimmed). The first line of the CSV file is considered as the header, and must contain the field names, with the exact same upper/lower case. String fields must be enclosed in double quotes (`\"`), numeric / boolean fields must not. Date fields must be strings in ISO 8601 format (e.g., `2023-10-01T12:00:00Z`).

Parameters:

businessDataType - Business Data Type (required)

dataset - (optional)

Returns:

BusinessDataImportResult

importBusinessDataWithHttpInfo

ApiResponse<BusinessDataImportResult> importBusinessDataWithHttpInfo(String businessDataType,
 File dataset)

Import Business Data by bulk Similar to importBusinessData but it also returns the http response headers .  Allows to import business data in bulk by uploading a file containing the data, in CSV format. Example CSV file content: ```csv firstName,lastName,department, dptReference, dateOfBirth, dateOfBirthWithTime, meetingDateAndTimeWithTimezone, otherDateAndTimeWithTimezone \"John\",\"Doe\",\"Engineering\", 14, \"1907-05-26\", \"1907-05-26T01:59:42\", \"2025-11-29T10:15:00+01:00\", \"2025-11-29T10:15:00Z\" \"Jane\",\"Smith\", \"Marketing\", 17, \"1977-03-24\", \"1977-03-24T17:40:00\", \"2025-07-19T09:00:00+01:00\", \"2025-07-19T09:00:00Z\" ``` Field separator can be comma (`,`) or semicolon (`;`). Space characters around the separator will be ignored (trimmed). The first line of the CSV file is considered as the header, and must contain the field names, with the exact same upper/lower case. String fields must be enclosed in double quotes (`\"`), numeric / boolean fields must not. Date fields must be strings in ISO 8601 format (e.g., `2023-10-01T12:00:00Z`).

Parameters:

businessDataType - Business Data Type (required)

dataset - (optional)

Returns:

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

insertBusinessData

BusinessDataCreationResult insertBusinessData(String businessDataType,
 Object body)

Create new Business Data  Create (Insert) new Business Data. Obviously, all mandatory fields of the given business data type must be provided in the request body, to ensure data integrity. Any input fields that are NOT part of the business data type will be simply ignored, and returned in the response, as an informative list.

Parameters:

businessDataType - The Business Data type to create (required)

body - The flat JSON object representing the fields of the business data to create. The fields to provide depend on the business data type. Any nullable field not provided will be left blank. Any unknown field will be ignored and return in the response, under the name \"unknownFields\". String fields must be enclosed in double quotes (`\"`), numeric / boolean fields must not. Date fields must be strings in ISO 8601 format (e.g., `2023-10-01T12:00:00Z`). (required)

Returns:

BusinessDataCreationResult

insertBusinessDataWithHttpInfo

ApiResponse<BusinessDataCreationResult> insertBusinessDataWithHttpInfo(String businessDataType,
 Object body)

Create new Business Data Similar to insertBusinessData but it also returns the http response headers .  Create (Insert) new Business Data. Obviously, all mandatory fields of the given business data type must be provided in the request body, to ensure data integrity. Any input fields that are NOT part of the business data type will be simply ignored, and returned in the response, as an informative list.

Parameters:

businessDataType - The Business Data type to create (required)

body - The flat JSON object representing the fields of the business data to create. The fields to provide depend on the business data type. Any nullable field not provided will be left blank. Any unknown field will be ignored and return in the response, under the name \"unknownFields\". String fields must be enclosed in double quotes (`\"`), numeric / boolean fields must not. Date fields must be strings in ISO 8601 format (e.g., `2023-10-01T12:00:00Z`). (required)

Returns:

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

updateBusinessData

BusinessDataUpdateResult updateBusinessData(String businessDataType,
 BigDecimal persistenceId,
 Object body)

Update an existing Business Data  Update an existing Business Data. Any input fields that are NOT part of the business data type will be simply ignored, and returned in the response, as an informative list.

Parameters:

businessDataType - The Business Data type to update (required)

persistenceId - Business data ID (required)

body - The flat JSON object representing the fields of the business data to update. The fields to provide depend on the business data type. Any field not provided will be left unchanged. Any unknown field will be ignored and return in the response, under the name \"unknownFields\". String fields must be enclosed in double quotes (`\"`), numeric / boolean fields must not. Date fields must be strings in ISO 8601 format (e.g., `2023-10-01T12:00:00Z`). (required)

Returns:

BusinessDataUpdateResult

updateBusinessDataWithHttpInfo

ApiResponse<BusinessDataUpdateResult> updateBusinessDataWithHttpInfo(String businessDataType,
 BigDecimal persistenceId,
 Object body)

Update an existing Business Data Similar to updateBusinessData but it also returns the http response headers .  Update an existing Business Data. Any input fields that are NOT part of the business data type will be simply ignored, and returned in the response, as an informative list.

Parameters:

businessDataType - The Business Data type to update (required)

persistenceId - Business data ID (required)

body - The flat JSON object representing the fields of the business data to update. The fields to provide depend on the business data type. Any field not provided will be left unchanged. Any unknown field will be ignored and return in the response, under the name \"unknownFields\". String fields must be enclosed in double quotes (`\"`), numeric / boolean fields must not. Date fields must be strings in ISO 8601 format (e.g., `2023-10-01T12:00:00Z`). (required)

Returns:

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