Package org.bonitasoft.web.client.api

Interface ArchivedHumanTaskApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ArchivedHumanTaskApi.SearchArchivedHumanTasksQueryParams	A convenience class for generating query parameters for the searchArchivedHumanTasks method in a fluent style.

Method Summary

Modifier and Type	Method	Description
ArchivedHumanTask	getArchivedHumanTaskById(String id)	Finds the ArchivedHumanTask by ID Returns the single ArchivedHumanTask for the given ID
ApiResponse<ArchivedHumanTask>	getArchivedHumanTaskByIdWithHttpInfo(String id)	Finds the ArchivedHumanTask by ID Similar to getArchivedHumanTaskById but it also returns the http response headers .
List<ArchivedHumanTask>	searchArchivedHumanTasks(Integer p, Integer c, List<String> f, String o)	Finds ArchivedHumanTasks Finds ArchivedHumanTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the human tasks assigned to the specified ID.
List<ArchivedHumanTask>	searchArchivedHumanTasks(Map<String,Object> queryParams)	Finds ArchivedHumanTasks Finds ArchivedHumanTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the human tasks assigned to the specified ID.
ApiResponse<List<ArchivedHumanTask>>	searchArchivedHumanTasksWithHttpInfo(Integer p, Integer c, List<String> f, String o)	Finds ArchivedHumanTasks Similar to searchArchivedHumanTasks but it also returns the http response headers .
ApiResponse<List<ArchivedHumanTask>>	searchArchivedHumanTasksWithHttpInfo(Map<String,Object> queryParams)	Finds ArchivedHumanTasks Finds ArchivedHumanTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the human tasks assigned to the specified ID.

Method Detail

getArchivedHumanTaskById

ArchivedHumanTask getArchivedHumanTaskById(String id)

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

Parameters:

id - ID of the ArchivedHumanTask to return (required)

Returns:

ArchivedHumanTask

getArchivedHumanTaskByIdWithHttpInfo

ApiResponse<ArchivedHumanTask> getArchivedHumanTaskByIdWithHttpInfo(String id)

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

Parameters:

id - ID of the ArchivedHumanTask to return (required)

Returns:

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

searchArchivedHumanTasks

List<ArchivedHumanTask> searchArchivedHumanTasks(Integer p,
                                                 Integer c,
                                                 List<String> f,
                                                 String o)

Finds ArchivedHumanTasks Finds ArchivedHumanTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the human tasks assigned to the specified ID. For example, retrieve the human tasks assigned to user with id 2: `/API/bpm/archivedHumanTask?p=0&c=10&f=assigned_id%3d2` * `state=`: retrieve only the archived user tasks with the specified state. For example, retrieve the skipped tasks: `/API/bpm/archivedHumanTask?p=0&c=10&f=state=skipped` * `name=`: retrieve only the human tasks with the specified name. For example, retrieve the human tasks with the name \"Analyse ProcessInstance\": `/API/bpm/archivedHumanTask?p=0&c=10&f=name=Analyse ProcessInstance` * `displayName=`: retrieve only the archived user tasks with the specified displayName. For example, retrieve the human tasks with the displayName \"Analyse ProcessInstance\": `/API/bpm/archivedHumanTask?p=0&c=10&f=displayName=Analyse ProcessInstance`

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

searchArchivedHumanTasksWithHttpInfo

ApiResponse<List<ArchivedHumanTask>> searchArchivedHumanTasksWithHttpInfo(Integer p,
                                                                          Integer c,
                                                                          List<String> f,
                                                                          String o)

Finds ArchivedHumanTasks Similar to searchArchivedHumanTasks but it also returns the http response headers . Finds ArchivedHumanTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the human tasks assigned to the specified ID. For example, retrieve the human tasks assigned to user with id 2: `/API/bpm/archivedHumanTask?p=0&c=10&f=assigned_id%3d2` * `state=`: retrieve only the archived user tasks with the specified state. For example, retrieve the skipped tasks: `/API/bpm/archivedHumanTask?p=0&c=10&f=state=skipped` * `name=`: retrieve only the human tasks with the specified name. For example, retrieve the human tasks with the name \"Analyse ProcessInstance\": `/API/bpm/archivedHumanTask?p=0&c=10&f=name=Analyse ProcessInstance` * `displayName=`: retrieve only the archived user tasks with the specified displayName. For example, retrieve the human tasks with the displayName \"Analyse ProcessInstance\": `/API/bpm/archivedHumanTask?p=0&c=10&f=displayName=Analyse ProcessInstance`

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.

searchArchivedHumanTasks

List<ArchivedHumanTask> searchArchivedHumanTasks(Map<String,Object> queryParams)

Finds ArchivedHumanTasks Finds ArchivedHumanTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the human tasks assigned to the specified ID. For example, retrieve the human tasks assigned to user with id 2: `/API/bpm/archivedHumanTask?p=0&c=10&f=assigned_id%3d2` * `state=`: retrieve only the archived user tasks with the specified state. For example, retrieve the skipped tasks: `/API/bpm/archivedHumanTask?p=0&c=10&f=state=skipped` * `name=`: retrieve only the human tasks with the specified name. For example, retrieve the human tasks with the name \"Analyse ProcessInstance\": `/API/bpm/archivedHumanTask?p=0&c=10&f=name=Analyse ProcessInstance` * `displayName=`: retrieve only the archived user tasks with the specified displayName. For example, retrieve the human tasks with the displayName \"Analyse ProcessInstance\": `/API/bpm/archivedHumanTask?p=0&c=10&f=displayName=Analyse ProcessInstance` Note, this is equivalent to the other searchArchivedHumanTasks 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 ArchivedHumanTaskApi.SearchArchivedHumanTasksQueryParams 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<ArchivedHumanTask>

searchArchivedHumanTasksWithHttpInfo

ApiResponse<List<ArchivedHumanTask>> searchArchivedHumanTasksWithHttpInfo(Map<String,Object> queryParams)

Finds ArchivedHumanTasks Finds ArchivedHumanTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the human tasks assigned to the specified ID. For example, retrieve the human tasks assigned to user with id 2: `/API/bpm/archivedHumanTask?p=0&c=10&f=assigned_id%3d2` * `state=`: retrieve only the archived user tasks with the specified state. For example, retrieve the skipped tasks: `/API/bpm/archivedHumanTask?p=0&c=10&f=state=skipped` * `name=`: retrieve only the human tasks with the specified name. For example, retrieve the human tasks with the name \"Analyse ProcessInstance\": `/API/bpm/archivedHumanTask?p=0&c=10&f=name=Analyse ProcessInstance` * `displayName=`: retrieve only the archived user tasks with the specified displayName. For example, retrieve the human tasks with the displayName \"Analyse ProcessInstance\": `/API/bpm/archivedHumanTask?p=0&c=10&f=displayName=Analyse ProcessInstance` Note, this is equivalent to the other searchArchivedHumanTasks 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<ArchivedHumanTask>