Package org.bonitasoft.web.client.api

Interface ActivityApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ActivityApi.SearchActivitiesQueryParams	A convenience class for generating query parameters for the searchActivities method in a fluent style.

Method Summary

Modifier and Type	Method	Description
Activity	getActivityById(String id)	Finds the Activity by ID Returns the single Activity for the given ID
ApiResponse<Activity>	getActivityByIdWithHttpInfo(String id)	Finds the Activity by ID Similar to getActivityById but it also returns the http response headers .
List<Activity>	searchActivities(Integer p, Integer c, List<String> f, String o, String s)	Finds Activities Finds Activities with pagination params and filters.
List<Activity>	searchActivities(Map<String,Object> queryParams)	Finds Activities Finds Activities with pagination params and filters.
ApiResponse<List<Activity>>	searchActivitiesWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)	Finds Activities Similar to searchActivities but it also returns the http response headers .
ApiResponse<List<Activity>>	searchActivitiesWithHttpInfo(Map<String,Object> queryParams)	Finds Activities Finds Activities with pagination params and filters.
void	updateActivityById(String id, ActivityUpdateRequest activityUpdateRequest)	Update the Activity by ID Update the Activity for the given ID
ApiResponse<Void>	updateActivityByIdWithHttpInfo(String id, ActivityUpdateRequest activityUpdateRequest)	Update the Activity by ID Similar to updateActivityById but it also returns the http response headers .

Method Detail

getActivityById

Activity getActivityById(String id)

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

Parameters:

id - ID of the Activity to return (required)

Returns:

Activity

getActivityByIdWithHttpInfo

ApiResponse<Activity> getActivityByIdWithHttpInfo(String id)

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

Parameters:

id - ID of the Activity to return (required)

Returns:

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

searchActivities

List<Activity> searchActivities(Integer p,
                                Integer c,
                                List<String> f,
                                String o,
                                String s)

Finds Activities Finds 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`, `displayName`, `state`, `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (order by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can search on `name`, `displayName`, `state`, `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (order by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can filter on `name`, `state`, `processId`, `parentProcessInstanceId`, `rootProcessInstanceId`, `last_update_date`, `supervisor_id` (only in Enterprise editions)

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

searchActivitiesWithHttpInfo

ApiResponse<List<Activity>> searchActivitiesWithHttpInfo(Integer p,
                                                         Integer c,
                                                         List<String> f,
                                                         String o,
                                                         String s)

Finds Activities Similar to searchActivities but it also returns the http response headers . Finds 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`, `displayName`, `state`, `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (order by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can search on `name`, `displayName`, `state`, `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (order by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can filter on `name`, `state`, `processId`, `parentProcessInstanceId`, `rootProcessInstanceId`, `last_update_date`, `supervisor_id` (only in Enterprise editions)

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.

searchActivities

List<Activity> searchActivities(Map<String,Object> queryParams)

Finds Activities Finds 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`, `displayName`, `state`, `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (order by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can search on `name`, `displayName`, `state`, `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (order by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can filter on `name`, `state`, `processId`, `parentProcessInstanceId`, `rootProcessInstanceId`, `last_update_date`, `supervisor_id` (only in Enterprise editions) Note, this is equivalent to the other searchActivities 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 ActivityApi.SearchActivitiesQueryParams 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<Activity>

searchActivitiesWithHttpInfo

ApiResponse<List<Activity>> searchActivitiesWithHttpInfo(Map<String,Object> queryParams)

Finds Activities Finds 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`, `displayName`, `state`, `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (order by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can search on `name`, `displayName`, `state`, `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (order by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can filter on `name`, `state`, `processId`, `parentProcessInstanceId`, `rootProcessInstanceId`, `last_update_date`, `supervisor_id` (only in Enterprise editions) Note, this is equivalent to the other searchActivities 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<Activity>

updateActivityById

void updateActivityById(String id,
                        ActivityUpdateRequest activityUpdateRequest)

Update the Activity by ID Update the Activity for the given ID

Parameters:

id - ID of the Activity to return (required)

activityUpdateRequest - Partial Activity description (required)

updateActivityByIdWithHttpInfo

ApiResponse<Void> updateActivityByIdWithHttpInfo(String id,
                                                 ActivityUpdateRequest activityUpdateRequest)

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

Parameters:

id - ID of the Activity to return (required)

activityUpdateRequest - Partial Activity description (required)