Package org.bonitasoft.web.client.api

Interface ArchivedManualTaskApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ArchivedManualTaskApi.SearchArchivedManualTasksQueryParams	A convenience class for generating query parameters for the searchArchivedManualTasks method in a fluent style.

Method Summary

Modifier and Type	Method	Description
ArchivedManualTask	getArchivedManualTaskById(String id)	Finds the ArchivedManualTask by ID Returns the single ArchivedManualTask for the given ID
ApiResponse<ArchivedManualTask>	getArchivedManualTaskByIdWithHttpInfo(String id)	Finds the ArchivedManualTask by ID Similar to getArchivedManualTaskById but it also returns the http response headers .
List<ArchivedManualTask>	searchArchivedManualTasks(Integer p, Integer c, List<String> f, String o)	Finds ArchivedManualTasks Finds ArchivedManualTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the human tasks assigned to the specified ID.
List<ArchivedManualTask>	searchArchivedManualTasks(ArchivedManualTaskApi.SearchArchivedManualTasksQueryParams queryParams)	Finds ArchivedManualTasks Finds ArchivedManualTasks 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<ArchivedManualTask>>	searchArchivedManualTasksWithHttpInfo(Integer p, Integer c, List<String> f, String o)	Finds ArchivedManualTasks Similar to searchArchivedManualTasks but it also returns the http response headers .
ApiResponse<List<ArchivedManualTask>>	searchArchivedManualTasksWithHttpInfo(ArchivedManualTaskApi.SearchArchivedManualTasksQueryParams queryParams)	Finds ArchivedManualTasks Finds ArchivedManualTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the human tasks assigned to the specified ID.

Method Details

getArchivedManualTaskById

ArchivedManualTask getArchivedManualTaskById(String id)

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

Parameters:

id - ID of the ArchivedManualTask to return (required)

Returns:

ArchivedManualTask

getArchivedManualTaskByIdWithHttpInfo

ApiResponse<ArchivedManualTask> getArchivedManualTaskByIdWithHttpInfo(String id)

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

Parameters:

id - ID of the ArchivedManualTask to return (required)

Returns:

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

searchArchivedManualTasks

List<ArchivedManualTask> searchArchivedManualTasks(Integer p,
 Integer c,
 List<String> f,
 String o)

Finds ArchivedManualTasks Finds ArchivedManualTasks 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<ArchivedManualTask>

searchArchivedManualTasksWithHttpInfo

ApiResponse<List<ArchivedManualTask>> searchArchivedManualTasksWithHttpInfo(Integer p,
 Integer c,
 List<String> f,
 String o)

Finds ArchivedManualTasks Similar to searchArchivedManualTasks but it also returns the http response headers . Finds ArchivedManualTasks 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.

searchArchivedManualTasks

List<ArchivedManualTask> searchArchivedManualTasks(ArchivedManualTaskApi.SearchArchivedManualTasksQueryParams queryParams)

Finds ArchivedManualTasks Finds ArchivedManualTasks 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 searchArchivedManualTasks 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 ArchivedManualTaskApi.SearchArchivedManualTasksQueryParams 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<ArchivedManualTask>

searchArchivedManualTasksWithHttpInfo

ApiResponse<List<ArchivedManualTask>> searchArchivedManualTasksWithHttpInfo(ArchivedManualTaskApi.SearchArchivedManualTasksQueryParams queryParams)

Finds ArchivedManualTasks Finds ArchivedManualTasks 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 searchArchivedManualTasks 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<ArchivedManualTask>