Package org.bonitasoft.web.client.api

Interface CustomUserValueApi

All Superinterfaces:

ApiClient.Api

public interface CustomUserValueApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CustomUserValueApi.SearchCustomUserValuesQueryParams	A convenience class for generating query parameters for the searchCustomUserValues method in a fluent style.

Method Summary

Modifier and Type	Method	Description
List<CustomUserValue>	searchCustomUserValues(Integer p, Integer c, List<String> f)	Finds CustomUserValues Finds CustomUserValues with pagination params and filters You can filter on `userId`, `value`, `definitionId`
List<CustomUserValue>	searchCustomUserValues(Map<String,Object> queryParams)	Finds CustomUserValues Finds CustomUserValues with pagination params and filters You can filter on `userId`, `value`, `definitionId` Note, this is equivalent to the other searchCustomUserValues method, but with the query parameters collected into a single Map parameter.
void	updateCustomUserValueById(String userId, String definitionId, CustomUserValueUpdateRequest customUserValueUpdateRequest)	Update the CustomUserValue by ID Update the CustomUserValue for the given ID

Method Detail

searchCustomUserValues

List<CustomUserValue> searchCustomUserValues(Integer p,
                                             Integer c,
                                             List<String> f)

Finds CustomUserValues Finds CustomUserValues with pagination params and filters You can filter on `userId`, `value`, `definitionId`

Parameters:

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

searchCustomUserValues

List<CustomUserValue> searchCustomUserValues(Map<String,Object> queryParams)

Finds CustomUserValues Finds CustomUserValues with pagination params and filters You can filter on `userId`, `value`, `definitionId` Note, this is equivalent to the other searchCustomUserValues 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 CustomUserValueApi.SearchCustomUserValuesQueryParams class that allows for building up this map in a fluent style.

Parameters:

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

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

updateCustomUserValueById

void updateCustomUserValueById(String userId,
                               String definitionId,
                               CustomUserValueUpdateRequest customUserValueUpdateRequest)

Update the CustomUserValue by ID Update the CustomUserValue for the given ID

Parameters:

userId - User ID (required)

definitionId - definition ID (required)

customUserValueUpdateRequest - Custom user defition Value (required)