Package org.bonitasoft.web.client.api

Interface ArchivedActivityApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ArchivedActivityApi.SearchArchivedActivitiesQueryParams	A convenience class for generating query parameters for the searchArchivedActivities method in a fluent style.

Method Summary

Modifier and Type	Method	Description
ArchivedActivity	getArchivedActivityById(String id)	Finds the Archived Activity by ID Returns the single Archived Activity for the given ID
ApiResponse<ArchivedActivity>	getArchivedActivityByIdWithHttpInfo(String id)	Finds the Archived Activity by ID Similar to getArchivedActivityById but it also returns the http response headers .
List<ArchivedActivity>	searchArchivedActivities(Integer p, Integer c, List<String> f, String o, String s)	Finds Archived Activities Finds Archived Activities with pagination params and filters.
List<ArchivedActivity>	searchArchivedActivities(Map<String,Object> queryParams)	Finds Archived Activities Finds Archived Activities with pagination params and filters.
ApiResponse<List<ArchivedActivity>>	searchArchivedActivitiesWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)	Finds Archived Activities Similar to searchArchivedActivities but it also returns the http response headers .
ApiResponse<List<ArchivedActivity>>	searchArchivedActivitiesWithHttpInfo(Map<String,Object> queryParams)	Finds Archived Activities Finds Archived Activities with pagination params and filters.

Method Detail

getArchivedActivityById

ArchivedActivity getArchivedActivityById(String id)

Finds the Archived Activity by ID Returns the single Archived Activity for the given ID

Parameters:

id - ID of the Archived Activity to return (required)

Returns:

ArchivedActivity

getArchivedActivityByIdWithHttpInfo

ApiResponse<ArchivedActivity> getArchivedActivityByIdWithHttpInfo(String id)

Finds the Archived Activity by ID Similar to getArchivedActivityById but it also returns the http response headers . Returns the single Archived Activity for the given ID

Parameters:

id - ID of the Archived Activity to return (required)

Returns:

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

searchArchivedActivities

List<ArchivedActivity> searchArchivedActivities(Integer p,
                                                Integer c,
                                                List<String> f,
                                                String o,
                                                String s)

Finds Archived Activities Finds Archived Activities with pagination params and filters. Activities in states completed, cancelled, or aborted are not retrieved. The search returns an array of activities. Can order on: - `name` : the name of this activity - `displayName` : the display name of this activity - `state` : the current state of the activity - `type` : the activity type - `isTerminal` : say whether or not the activity is in a terminal state - `processId` : the process this activity is associated to - `caseId` : the process instance initiator this activity is associated to - `reached_state_date` : the date when this activity arrived in this state Can filter on: - `supervisor_id`: retrieve the information the process manager associated to this id has access to (only in Enterprise editions) - f: same as the sort order fields

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

searchArchivedActivitiesWithHttpInfo

ApiResponse<List<ArchivedActivity>> searchArchivedActivitiesWithHttpInfo(Integer p,
                                                                         Integer c,
                                                                         List<String> f,
                                                                         String o,
                                                                         String s)

Finds Archived Activities Similar to searchArchivedActivities but it also returns the http response headers . Finds Archived Activities with pagination params and filters. Activities in states completed, cancelled, or aborted are not retrieved. The search returns an array of activities. Can order on: - `name` : the name of this activity - `displayName` : the display name of this activity - `state` : the current state of the activity - `type` : the activity type - `isTerminal` : say whether or not the activity is in a terminal state - `processId` : the process this activity is associated to - `caseId` : the process instance initiator this activity is associated to - `reached_state_date` : the date when this activity arrived in this state Can filter on: - `supervisor_id`: retrieve the information the process manager associated to this id has access to (only in Enterprise editions) - f: same as the sort order fields

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.

searchArchivedActivities

List<ArchivedActivity> searchArchivedActivities(Map<String,Object> queryParams)

Finds Archived Activities Finds Archived Activities with pagination params and filters. Activities in states completed, cancelled, or aborted are not retrieved. The search returns an array of activities. Can order on: - `name` : the name of this activity - `displayName` : the display name of this activity - `state` : the current state of the activity - `type` : the activity type - `isTerminal` : say whether or not the activity is in a terminal state - `processId` : the process this activity is associated to - `caseId` : the process instance initiator this activity is associated to - `reached_state_date` : the date when this activity arrived in this state Can filter on: - `supervisor_id`: retrieve the information the process manager associated to this id has access to (only in Enterprise editions) - f: same as the sort order fields Note, this is equivalent to the other searchArchivedActivities 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 ArchivedActivityApi.SearchArchivedActivitiesQueryParams 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<ArchivedActivity>

searchArchivedActivitiesWithHttpInfo

ApiResponse<List<ArchivedActivity>> searchArchivedActivitiesWithHttpInfo(Map<String,Object> queryParams)

Finds Archived Activities Finds Archived Activities with pagination params and filters. Activities in states completed, cancelled, or aborted are not retrieved. The search returns an array of activities. Can order on: - `name` : the name of this activity - `displayName` : the display name of this activity - `state` : the current state of the activity - `type` : the activity type - `isTerminal` : say whether or not the activity is in a terminal state - `processId` : the process this activity is associated to - `caseId` : the process instance initiator this activity is associated to - `reached_state_date` : the date when this activity arrived in this state Can filter on: - `supervisor_id`: retrieve the information the process manager associated to this id has access to (only in Enterprise editions) - f: same as the sort order fields Note, this is equivalent to the other searchArchivedActivities 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<ArchivedActivity>