Package org.bonitasoft.web.client.api

Interface TaskApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TaskApi.SearchTasksQueryParams	A convenience class for generating query parameters for the searchTasks method in a fluent style.

Method Summary

Modifier and Type	Method	Description
Task	getTaskById(String id)	Finds the Task by ID Returns the single Task for the given ID
ApiResponse<Task>	getTaskByIdWithHttpInfo(String id)	Finds the Task by ID Similar to getTaskById but it also returns the http response headers .
List<Task>	searchTasks(Integer p, Integer c, List<String> f, String o)	Finds Tasks Finds Tasks with pagination params and filters - can order on `caseId`, `processId`, `state`, `type`, `supervisor_id`, `last_update_date` - can filter on `caseId`, `processId`, `state`, `type`, `supervisor_id`, `last_update_date`
List<Task>	searchTasks(TaskApi.SearchTasksQueryParams queryParams)	Finds Tasks Finds Tasks with pagination params and filters - can order on `caseId`, `processId`, `state`, `type`, `supervisor_id`, `last_update_date` - can filter on `caseId`, `processId`, `state`, `type`, `supervisor_id`, `last_update_date` Note, this is equivalent to the other searchTasks method, but with the query parameters collected into a single Map parameter.
ApiResponse<List<Task>>	searchTasksWithHttpInfo(Integer p, Integer c, List<String> f, String o)	Finds Tasks Similar to searchTasks but it also returns the http response headers .
ApiResponse<List<Task>>	searchTasksWithHttpInfo(TaskApi.SearchTasksQueryParams queryParams)	Finds Tasks Finds Tasks with pagination params and filters - can order on `caseId`, `processId`, `state`, `type`, `supervisor_id`, `last_update_date` - can filter on `caseId`, `processId`, `state`, `type`, `supervisor_id`, `last_update_date` Note, this is equivalent to the other searchTasks that receives the query parameters as a map, but this one also exposes the Http response headers
void	updateTaskById(String id, UpdateTaskByIdRequest updateTaskByIdRequest)	Update the Task by ID Update the Task for the given ID
ApiResponse<Void>	updateTaskByIdWithHttpInfo(String id, UpdateTaskByIdRequest updateTaskByIdRequest)	Update the Task by ID Similar to updateTaskById but it also returns the http response headers .

Method Details

getTaskById

Task getTaskById(String id)

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

Parameters:

id - ID of the Task to return (required)

Returns:

Task

getTaskByIdWithHttpInfo

ApiResponse<Task> getTaskByIdWithHttpInfo(String id)

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

Parameters:

id - ID of the Task to return (required)

Returns:

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

searchTasks

List<Task> searchTasks(Integer p,
 Integer c,
 List<String> f,
 String o)

Finds Tasks Finds Tasks with pagination params and filters - can order on `caseId`, `processId`, `state`, `type`, `supervisor_id`, `last_update_date` - can filter on `caseId`, `processId`, `state`, `type`, `supervisor_id`, `last_update_date`

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)

Returns:

List<Task>

searchTasksWithHttpInfo

ApiResponse<List<Task>> searchTasksWithHttpInfo(Integer p,
 Integer c,
 List<String> f,
 String o)

Finds Tasks Similar to searchTasks but it also returns the http response headers . Finds Tasks with pagination params and filters - can order on `caseId`, `processId`, `state`, `type`, `supervisor_id`, `last_update_date` - can filter on `caseId`, `processId`, `state`, `type`, `supervisor_id`, `last_update_date`

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)

Returns:

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

searchTasks

List<Task> searchTasks(TaskApi.SearchTasksQueryParams queryParams)

Finds Tasks Finds Tasks with pagination params and filters - can order on `caseId`, `processId`, `state`, `type`, `supervisor_id`, `last_update_date` - can filter on `caseId`, `processId`, `state`, `type`, `supervisor_id`, `last_update_date` Note, this is equivalent to the other searchTasks 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 TaskApi.SearchTasksQueryParams 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)

Returns:

List<Task>

searchTasksWithHttpInfo

ApiResponse<List<Task>> searchTasksWithHttpInfo(TaskApi.SearchTasksQueryParams queryParams)

Finds Tasks Finds Tasks with pagination params and filters - can order on `caseId`, `processId`, `state`, `type`, `supervisor_id`, `last_update_date` - can filter on `caseId`, `processId`, `state`, `type`, `supervisor_id`, `last_update_date` Note, this is equivalent to the other searchTasks 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)

Returns:

List<Task>

updateTaskById

void updateTaskById(String id,
 UpdateTaskByIdRequest updateTaskByIdRequest)

Update the Task by ID Update the Task for the given ID

Parameters:

id - ID of the Task to return (required)

updateTaskByIdRequest - Task fields to update (forbidden fields are : `caseId`, `processId`, `name`, `executedBy`, `type`, `id`, `reached_state_date`, `last_update_date`) (required)

updateTaskByIdWithHttpInfo

ApiResponse<Void> updateTaskByIdWithHttpInfo(String id,
 UpdateTaskByIdRequest updateTaskByIdRequest)

Update the Task by ID Similar to updateTaskById but it also returns the http response headers . Update the Task for the given ID

Parameters:

id - ID of the Task to return (required)

updateTaskByIdRequest - Task fields to update (forbidden fields are : `caseId`, `processId`, `name`, `executedBy`, `type`, `id`, `reached_state_date`, `last_update_date`) (required)