Package org.bonitasoft.web.client.api

Interface ArchivedUserTaskApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ArchivedUserTaskApi.SearchArchivedUserTasksQueryParams	A convenience class for generating query parameters for the searchArchivedUserTasks method in a fluent style.

Method Summary

Modifier and Type	Method	Description
ArchivedUserTask	getArchivedUserTaskById(String id)	Finds the ArchivedUserTask by ID Returns the single ArchivedUserTask for the given ID
ApiResponse<ArchivedUserTask>	getArchivedUserTaskByIdWithHttpInfo(String id)	Finds the ArchivedUserTask by ID Similar to getArchivedUserTaskById but it also returns the http response headers .
List<ArchivedUserTask>	searchArchivedUserTasks(Integer p, Integer c, List<String> f, String o)	Finds ArchivedUserTasks Finds ArchivedUserTasks with pagination params and filters.
List<ArchivedUserTask>	searchArchivedUserTasks(ArchivedUserTaskApi.SearchArchivedUserTasksQueryParams queryParams)	Finds ArchivedUserTasks Finds ArchivedUserTasks with pagination params and filters.
ApiResponse<List<ArchivedUserTask>>	searchArchivedUserTasksWithHttpInfo(Integer p, Integer c, List<String> f, String o)	Finds ArchivedUserTasks Similar to searchArchivedUserTasks but it also returns the http response headers .
ApiResponse<List<ArchivedUserTask>>	searchArchivedUserTasksWithHttpInfo(ArchivedUserTaskApi.SearchArchivedUserTasksQueryParams queryParams)	Finds ArchivedUserTasks Finds ArchivedUserTasks with pagination params and filters.

Method Details

getArchivedUserTaskById

ArchivedUserTask getArchivedUserTaskById(String id)

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

Parameters:

id - ID of the ArchivedUserTask to return (required)

Returns:

ArchivedUserTask

getArchivedUserTaskByIdWithHttpInfo

ApiResponse<ArchivedUserTask> getArchivedUserTaskByIdWithHttpInfo(String id)

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

Parameters:

id - ID of the ArchivedUserTask to return (required)

Returns:

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

searchArchivedUserTasks

List<ArchivedUserTask> searchArchivedUserTasks(Integer p,
 Integer c,
 List<String> f,
 String o)

Finds ArchivedUserTasks Finds ArchivedUserTasks with pagination params and filters. An ArchivedUserTask is an executable task that has been performed by a user or skipped and is archived. You can filter on: * `assigned_id={user_id}`: retrieve only the user tasks assigned to the specified ID. For example, retrieve the user tasks assigned to user with id 2: `/API/bpm/archivedUserTask?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/archivedUserTask?p=0&c=10&f=state=skipped` * `name=`: retrieve only the user tasks with the specified name. For example, retrieve the user tasks with the name \"Analyse ProcessInstance\": `/API/bpm/archivedUserTask?p=0&c=10&f=name=Analyse ProcessInstance` * `displayName=`: retrieve only the archived user tasks with the specified displayName. For example, retrieve the user tasks with the displayName \"Analyse ProcessInstance\": `/API/bpm/archivedUserTask?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<ArchivedUserTask>

searchArchivedUserTasksWithHttpInfo

ApiResponse<List<ArchivedUserTask>> searchArchivedUserTasksWithHttpInfo(Integer p,
 Integer c,
 List<String> f,
 String o)

Finds ArchivedUserTasks Similar to searchArchivedUserTasks but it also returns the http response headers . Finds ArchivedUserTasks with pagination params and filters. An ArchivedUserTask is an executable task that has been performed by a user or skipped and is archived. You can filter on: * `assigned_id={user_id}`: retrieve only the user tasks assigned to the specified ID. For example, retrieve the user tasks assigned to user with id 2: `/API/bpm/archivedUserTask?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/archivedUserTask?p=0&c=10&f=state=skipped` * `name=`: retrieve only the user tasks with the specified name. For example, retrieve the user tasks with the name \"Analyse ProcessInstance\": `/API/bpm/archivedUserTask?p=0&c=10&f=name=Analyse ProcessInstance` * `displayName=`: retrieve only the archived user tasks with the specified displayName. For example, retrieve the user tasks with the displayName \"Analyse ProcessInstance\": `/API/bpm/archivedUserTask?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.

searchArchivedUserTasks

List<ArchivedUserTask> searchArchivedUserTasks(ArchivedUserTaskApi.SearchArchivedUserTasksQueryParams queryParams)

Finds ArchivedUserTasks Finds ArchivedUserTasks with pagination params and filters. An ArchivedUserTask is an executable task that has been performed by a user or skipped and is archived. You can filter on: * `assigned_id={user_id}`: retrieve only the user tasks assigned to the specified ID. For example, retrieve the user tasks assigned to user with id 2: `/API/bpm/archivedUserTask?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/archivedUserTask?p=0&c=10&f=state=skipped` * `name=`: retrieve only the user tasks with the specified name. For example, retrieve the user tasks with the name \"Analyse ProcessInstance\": `/API/bpm/archivedUserTask?p=0&c=10&f=name=Analyse ProcessInstance` * `displayName=`: retrieve only the archived user tasks with the specified displayName. For example, retrieve the user tasks with the displayName \"Analyse ProcessInstance\": `/API/bpm/archivedUserTask?p=0&c=10&f=displayName=Analyse ProcessInstance` Note, this is equivalent to the other searchArchivedUserTasks 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 ArchivedUserTaskApi.SearchArchivedUserTasksQueryParams 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<ArchivedUserTask>

searchArchivedUserTasksWithHttpInfo

ApiResponse<List<ArchivedUserTask>> searchArchivedUserTasksWithHttpInfo(ArchivedUserTaskApi.SearchArchivedUserTasksQueryParams queryParams)

Finds ArchivedUserTasks Finds ArchivedUserTasks with pagination params and filters. An ArchivedUserTask is an executable task that has been performed by a user or skipped and is archived. You can filter on: * `assigned_id={user_id}`: retrieve only the user tasks assigned to the specified ID. For example, retrieve the user tasks assigned to user with id 2: `/API/bpm/archivedUserTask?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/archivedUserTask?p=0&c=10&f=state=skipped` * `name=`: retrieve only the user tasks with the specified name. For example, retrieve the user tasks with the name \"Analyse ProcessInstance\": `/API/bpm/archivedUserTask?p=0&c=10&f=name=Analyse ProcessInstance` * `displayName=`: retrieve only the archived user tasks with the specified displayName. For example, retrieve the user tasks with the displayName \"Analyse ProcessInstance\": `/API/bpm/archivedUserTask?p=0&c=10&f=displayName=Analyse ProcessInstance` Note, this is equivalent to the other searchArchivedUserTasks 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<ArchivedUserTask>