Package org.bonitasoft.web.client.api

Interface ManualTaskApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ManualTaskApi.SearchManualTasksQueryParams	A convenience class for generating query parameters for the searchManualTasks method in a fluent style.

Method Summary

Modifier and Type	Method	Description
ManualTask	createManualTask(ManualTaskCreateRequest body)	Create the ManualTask Create the ManualTask.
ApiResponse<ManualTask>	createManualTaskWithHttpInfo(ManualTaskCreateRequest body)	Create the ManualTask Similar to createManualTask but it also returns the http response headers .
ManualTask	getManualTaskById(String id)	Finds the ManualTask by ID Returns the single ManualTask for the given ID
ApiResponse<ManualTask>	getManualTaskByIdWithHttpInfo(String id)	Finds the ManualTask by ID Similar to getManualTaskById but it also returns the http response headers .
List<ManualTask>	searchManualTasks(Integer p, Integer c, List<String> f, String o, String s)	Finds ManualTasks Finds ManualTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the manual tasks assigned to the specified user.
List<ManualTask>	searchManualTasks(Map<String,Object> queryParams)	Finds ManualTasks Finds ManualTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the manual tasks assigned to the specified user.
ApiResponse<List<ManualTask>>	searchManualTasksWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)	Finds ManualTasks Similar to searchManualTasks but it also returns the http response headers .
ApiResponse<List<ManualTask>>	searchManualTasksWithHttpInfo(Map<String,Object> queryParams)	Finds ManualTasks Finds ManualTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the manual tasks assigned to the specified user.
void	updateManualTaskById(String id, ManualTaskUpdateRequest manualTaskUpdateRequest)	Update the ManualTask by ID Update the ManualTask for the given ID.
ApiResponse<Void>	updateManualTaskByIdWithHttpInfo(String id, ManualTaskUpdateRequest manualTaskUpdateRequest)	Update the ManualTask by ID Similar to updateManualTaskById but it also returns the http response headers .

Method Detail

createManualTask

ManualTask createManualTask(ManualTaskCreateRequest body)

Create the ManualTask Create the ManualTask. Use a POST method to create a new subtask. A subtask is attached to a parent task and it needs to be immediately assigned to a user.

Parameters:

body - Partial ManualTask description (required)

Returns:

ManualTask

createManualTaskWithHttpInfo

ApiResponse<ManualTask> createManualTaskWithHttpInfo(ManualTaskCreateRequest body)

Create the ManualTask Similar to createManualTask but it also returns the http response headers . Create the ManualTask. Use a POST method to create a new subtask. A subtask is attached to a parent task and it needs to be immediately assigned to a user.

Parameters:

body - Partial ManualTask description (required)

Returns:

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

getManualTaskById

ManualTask getManualTaskById(String id)

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

Parameters:

id - ID of the ManualTask to return (required)

Returns:

ManualTask

getManualTaskByIdWithHttpInfo

ApiResponse<ManualTask> getManualTaskByIdWithHttpInfo(String id)

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

Parameters:

id - ID of the ManualTask to return (required)

Returns:

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

searchManualTasks

List<ManualTask> searchManualTasks(Integer p,
                                   Integer c,
                                   List<String> f,
                                   String o,
                                   String s)

Finds ManualTasks Finds ManualTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the manual tasks assigned to the specified user. For example, retrieve the manual tasks assigned to user with id 1: `/API/bpm/manualTask?p=0&c=10&f=assigned_id%3d1`. * `state=skipped | ready | completed | failed` : retrieve only the manual tasks with the specified state. For example, retrieve the ready tasks: `/API/bpm/manualTask?p=0&c=10&f=state%3dready`. * `caseId={case_id}`: retrieve only the manual tasks created in the specified process instances. For example, retrieve the manual tasks for the case\\_id 2: `/API/bpm/manualTask?p=0&c=10&f=caseId%3d2`. * `parentTaskId={parentTask_id}`: retrieve only the manual tasks for a specific parentTask. For example, retrieve the manual tasks for the parentTask\\_id 40001: `/API/bpm/manualTask?p=0&c=10&f=parentTaskId%3d40001`. You can search on: * name: search all manual tasks with a name that starts with the search string. For example, search for all manual tasks that have a name that starts with MySubTask: `/API/bpm/manualTask?p=0&c=10&s=MySubTask`.

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

searchManualTasksWithHttpInfo

ApiResponse<List<ManualTask>> searchManualTasksWithHttpInfo(Integer p,
                                                            Integer c,
                                                            List<String> f,
                                                            String o,
                                                            String s)

Finds ManualTasks Similar to searchManualTasks but it also returns the http response headers . Finds ManualTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the manual tasks assigned to the specified user. For example, retrieve the manual tasks assigned to user with id 1: `/API/bpm/manualTask?p=0&c=10&f=assigned_id%3d1`. * `state=skipped | ready | completed | failed` : retrieve only the manual tasks with the specified state. For example, retrieve the ready tasks: `/API/bpm/manualTask?p=0&c=10&f=state%3dready`. * `caseId={case_id}`: retrieve only the manual tasks created in the specified process instances. For example, retrieve the manual tasks for the case\\_id 2: `/API/bpm/manualTask?p=0&c=10&f=caseId%3d2`. * `parentTaskId={parentTask_id}`: retrieve only the manual tasks for a specific parentTask. For example, retrieve the manual tasks for the parentTask\\_id 40001: `/API/bpm/manualTask?p=0&c=10&f=parentTaskId%3d40001`. You can search on: * name: search all manual tasks with a name that starts with the search string. For example, search for all manual tasks that have a name that starts with MySubTask: `/API/bpm/manualTask?p=0&c=10&s=MySubTask`.

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.

searchManualTasks

List<ManualTask> searchManualTasks(Map<String,Object> queryParams)

Finds ManualTasks Finds ManualTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the manual tasks assigned to the specified user. For example, retrieve the manual tasks assigned to user with id 1: `/API/bpm/manualTask?p=0&c=10&f=assigned_id%3d1`. * `state=skipped | ready | completed | failed` : retrieve only the manual tasks with the specified state. For example, retrieve the ready tasks: `/API/bpm/manualTask?p=0&c=10&f=state%3dready`. * `caseId={case_id}`: retrieve only the manual tasks created in the specified process instances. For example, retrieve the manual tasks for the case\\_id 2: `/API/bpm/manualTask?p=0&c=10&f=caseId%3d2`. * `parentTaskId={parentTask_id}`: retrieve only the manual tasks for a specific parentTask. For example, retrieve the manual tasks for the parentTask\\_id 40001: `/API/bpm/manualTask?p=0&c=10&f=parentTaskId%3d40001`. You can search on: * name: search all manual tasks with a name that starts with the search string. For example, search for all manual tasks that have a name that starts with MySubTask: `/API/bpm/manualTask?p=0&c=10&s=MySubTask`. Note, this is equivalent to the other searchManualTasks 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 ManualTaskApi.SearchManualTasksQueryParams 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<ManualTask>

searchManualTasksWithHttpInfo

ApiResponse<List<ManualTask>> searchManualTasksWithHttpInfo(Map<String,Object> queryParams)

Finds ManualTasks Finds ManualTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the manual tasks assigned to the specified user. For example, retrieve the manual tasks assigned to user with id 1: `/API/bpm/manualTask?p=0&c=10&f=assigned_id%3d1`. * `state=skipped | ready | completed | failed` : retrieve only the manual tasks with the specified state. For example, retrieve the ready tasks: `/API/bpm/manualTask?p=0&c=10&f=state%3dready`. * `caseId={case_id}`: retrieve only the manual tasks created in the specified process instances. For example, retrieve the manual tasks for the case\\_id 2: `/API/bpm/manualTask?p=0&c=10&f=caseId%3d2`. * `parentTaskId={parentTask_id}`: retrieve only the manual tasks for a specific parentTask. For example, retrieve the manual tasks for the parentTask\\_id 40001: `/API/bpm/manualTask?p=0&c=10&f=parentTaskId%3d40001`. You can search on: * name: search all manual tasks with a name that starts with the search string. For example, search for all manual tasks that have a name that starts with MySubTask: `/API/bpm/manualTask?p=0&c=10&s=MySubTask`. Note, this is equivalent to the other searchManualTasks 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<ManualTask>

updateManualTaskById

void updateManualTaskById(String id,
                          ManualTaskUpdateRequest manualTaskUpdateRequest)

Update the ManualTask by ID Update the ManualTask for the given ID. Use a PUT method to execute a subtask. Executing a subtask basically means changing its state to completed and providing an executedBy value.

Parameters:

id - ID of the ManualTask to return (required)

manualTaskUpdateRequest - Partial ManualTask description (required)

updateManualTaskByIdWithHttpInfo

ApiResponse<Void> updateManualTaskByIdWithHttpInfo(String id,
                                                   ManualTaskUpdateRequest manualTaskUpdateRequest)

Update the ManualTask by ID Similar to updateManualTaskById but it also returns the http response headers . Update the ManualTask for the given ID. Use a PUT method to execute a subtask. Executing a subtask basically means changing its state to completed and providing an executedBy value.

Parameters:

id - ID of the ManualTask to return (required)

manualTaskUpdateRequest - Partial ManualTask description (required)