Package org.bonitasoft.web.client.api

Interface UserTaskApi

All Superinterfaces:

ApiClient.Api

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public interface UserTaskApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	UserTaskApi.ExecuteUserTaskQueryParams	A convenience class for generating query parameters for the executeUserTask method in a fluent style.
static class	UserTaskApi.SearchUserTasksQueryParams	A convenience class for generating query parameters for the searchUserTasks method in a fluent style.

Method Summary

Modifier and Type	Method	Description
void	executeUserTask(String id, Map<String,Object> body, Boolean assign)	Execute the UserTask Execute the UserTask.
void	executeUserTask(String id, Map<String,Object> body, Map<String,Object> queryParams)	Execute the UserTask Execute the UserTask.
ApiResponse<Void>	executeUserTaskWithHttpInfo(String id, Map<String,Object> body, Boolean assign)	Execute the UserTask Similar to executeUserTask but it also returns the http response headers .
ApiResponse<Void>	executeUserTaskWithHttpInfo(String id, Map<String,Object> body, Map<String,Object> queryParams)	Execute the UserTask Execute the UserTask.
Map<String,Object>	getContextByUserTaskId(String id)	Finds the Context by UserTask ID Returns the Context for the given UserTask ID
ApiResponse<Map<String,Object>>	getContextByUserTaskIdWithHttpInfo(String id)	Finds the Context by UserTask ID Similar to getContextByUserTaskId but it also returns the http response headers .
Contract	getContractByUserTaskId(String id)	Finds the Contract by UserTask ID Returns the Contract for the given UserTask ID
ApiResponse<Contract>	getContractByUserTaskIdWithHttpInfo(String id)	Finds the Contract by UserTask ID Similar to getContractByUserTaskId but it also returns the http response headers .
UserTask	getUserTaskById(String id)	Finds the UserTask by ID Returns the single UserTask for the given ID
ApiResponse<UserTask>	getUserTaskByIdWithHttpInfo(String id)	Finds the UserTask by ID Similar to getUserTaskById but it also returns the http response headers .
List<UserTask>	searchUserTasks(Integer p, Integer c, List<String> f, String o, String s)	Finds UserTasks Finds UserTasks with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName`
List<UserTask>	searchUserTasks(Map<String,Object> queryParams)	Finds UserTasks Finds UserTasks with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName` Note, this is equivalent to the other searchUserTasks method, but with the query parameters collected into a single Map parameter.
ApiResponse<List<UserTask>>	searchUserTasksWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)	Finds UserTasks Similar to searchUserTasks but it also returns the http response headers .
ApiResponse<List<UserTask>>	searchUserTasksWithHttpInfo(Map<String,Object> queryParams)	Finds UserTasks Finds UserTasks with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName` Note, this is equivalent to the other searchUserTasks that receives the query parameters as a map, but this one also exposes the Http response headers
void	updateUserTaskById(String id, UserTaskUpdateRequest userTaskUpdateRequest)	Update the UserTask by ID Update the UserTask for the given ID.
ApiResponse<Void>	updateUserTaskByIdWithHttpInfo(String id, UserTaskUpdateRequest userTaskUpdateRequest)	Update the UserTask by ID Similar to updateUserTaskById but it also returns the http response headers .

Method Detail

executeUserTask

void executeUserTask(String id,
                     Map<String,Object> body,
                     Boolean assign)

Execute the UserTask Execute the UserTask. In order to execute a task, the task contract values have to be provided.

Parameters:

id - ID of the UserTask to execute (required)

body - A JSON object matching task contract. Execute a task providing correct contract values. (required)

assign - if true, assign the task to the current user and execute the task (optional)

executeUserTaskWithHttpInfo

ApiResponse<Void> executeUserTaskWithHttpInfo(String id,
                                              Map<String,Object> body,
                                              Boolean assign)

Execute the UserTask Similar to executeUserTask but it also returns the http response headers . Execute the UserTask. In order to execute a task, the task contract values have to be provided.

Parameters:

id - ID of the UserTask to execute (required)

body - A JSON object matching task contract. Execute a task providing correct contract values. (required)

assign - if true, assign the task to the current user and execute the task (optional)

executeUserTask

void executeUserTask(String id,
                     Map<String,Object> body,
                     Map<String,Object> queryParams)

Execute the UserTask Execute the UserTask. In order to execute a task, the task contract values have to be provided. Note, this is equivalent to the other executeUserTask 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 UserTaskApi.ExecuteUserTaskQueryParams class that allows for building up this map in a fluent style.

Parameters:

id - ID of the UserTask to execute (required)

body - A JSON object matching task contract. Execute a task providing correct contract values. (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• assign - if true, assign the task to the current user and execute the task (optional)

executeUserTaskWithHttpInfo

ApiResponse<Void> executeUserTaskWithHttpInfo(String id,
                                              Map<String,Object> body,
                                              Map<String,Object> queryParams)

Execute the UserTask Execute the UserTask. In order to execute a task, the task contract values have to be provided. Note, this is equivalent to the other executeUserTask that receives the query parameters as a map, but this one also exposes the Http response headers

Parameters:

id - ID of the UserTask to execute (required)

body - A JSON object matching task contract. Execute a task providing correct contract values. (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• assign - if true, assign the task to the current user and execute the task (optional)

getContextByUserTaskId

Map<String,Object> getContextByUserTaskId(String id)

Finds the Context by UserTask ID Returns the Context for the given UserTask ID

Parameters:

id - ID of the UserTask that has the Context to return (required)

Returns:

Map<String, Object>

getContextByUserTaskIdWithHttpInfo

ApiResponse<Map<String,Object>> getContextByUserTaskIdWithHttpInfo(String id)

Finds the Context by UserTask ID Similar to getContextByUserTaskId but it also returns the http response headers . Returns the Context for the given UserTask ID

Parameters:

id - ID of the UserTask that has the Context to return (required)

Returns:

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

getContractByUserTaskId

Contract getContractByUserTaskId(String id)

Finds the Contract by UserTask ID Returns the Contract for the given UserTask ID

Parameters:

id - ID of the UserTask that has the Contract to return (required)

Returns:

Contract

getContractByUserTaskIdWithHttpInfo

ApiResponse<Contract> getContractByUserTaskIdWithHttpInfo(String id)

Finds the Contract by UserTask ID Similar to getContractByUserTaskId but it also returns the http response headers . Returns the Contract for the given UserTask ID

Parameters:

id - ID of the UserTask that has the Contract to return (required)

Returns:

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

getUserTaskById

UserTask getUserTaskById(String id)

Finds the UserTask by ID Returns the single UserTask for the given ID

Parameters:

id - ID of the UserTask to return (required)

Returns:

UserTask

getUserTaskByIdWithHttpInfo

ApiResponse<UserTask> getUserTaskByIdWithHttpInfo(String id)

Finds the UserTask by ID Similar to getUserTaskById but it also returns the http response headers . Returns the single UserTask for the given ID

Parameters:

id - ID of the UserTask to return (required)

Returns:

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

searchUserTasks

List<UserTask> searchUserTasks(Integer p,
                               Integer c,
                               List<String> f,
                               String o,
                               String s)

Finds UserTasks Finds UserTasks with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName`

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)

o - can order on attributes (optional)

s - can search on attributes (optional)

Returns:

List<UserTask>

searchUserTasksWithHttpInfo

ApiResponse<List<UserTask>> searchUserTasksWithHttpInfo(Integer p,
                                                        Integer c,
                                                        List<String> f,
                                                        String o,
                                                        String s)

Finds UserTasks Similar to searchUserTasks but it also returns the http response headers . Finds UserTasks with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName`

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)

o - can order on attributes (optional)

s - can search on attributes (optional)

Returns:

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

searchUserTasks

List<UserTask> searchUserTasks(Map<String,Object> queryParams)

Finds UserTasks Finds UserTasks with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName` Note, this is equivalent to the other searchUserTasks 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 UserTaskApi.SearchUserTasksQueryParams 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)
• o - can order on attributes (optional)
• s - can search on attributes (optional)

Returns:

List<UserTask>

searchUserTasksWithHttpInfo

ApiResponse<List<UserTask>> searchUserTasksWithHttpInfo(Map<String,Object> queryParams)

Finds UserTasks Finds UserTasks with pagination params and filters - can order on `id` - can search on `displayName` - can filter on `displayName` Note, this is equivalent to the other searchUserTasks that receives the query parameters as a map, but this one also exposes the Http response headers

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)
• o - can order on attributes (optional)
• s - can search on attributes (optional)

Returns:

List<UserTask>

updateUserTaskById

void updateUserTaskById(String id,
                        UserTaskUpdateRequest userTaskUpdateRequest)

Update the UserTask by ID Update the UserTask for the given ID. Fields that can be updated are `assigned_id` and `state`. The only value that can be set for the state is `skipped`. You only need to specify the fields that are to be updated.

Parameters:

id - ID of the UserTask to return (required)

userTaskUpdateRequest - Partial UserTask description (required)

updateUserTaskByIdWithHttpInfo

ApiResponse<Void> updateUserTaskByIdWithHttpInfo(String id,
                                                 UserTaskUpdateRequest userTaskUpdateRequest)

Update the UserTask by ID Similar to updateUserTaskById but it also returns the http response headers . Update the UserTask for the given ID. Fields that can be updated are `assigned_id` and `state`. The only value that can be set for the state is `skipped`. You only need to specify the fields that are to be updated.

Parameters:

id - ID of the UserTask to return (required)

userTaskUpdateRequest - Partial UserTask description (required)