Package org.bonitasoft.web.client.api

Interface ProcessInstanceApi

All Superinterfaces:

ApiClient.Api

public interface ProcessInstanceApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProcessInstanceApi.GetProcessInstanceByIdQueryParams	A convenience class for generating query parameters for the getProcessInstanceById method in a fluent style.
static class	ProcessInstanceApi.SearchProcessInstancesQueryParams	A convenience class for generating query parameters for the searchProcessInstances method in a fluent style.

Method Summary

Modifier and Type	Method	Description
ProcessInstance	createProcessInstance(ProcessInstanceCreateRequest body)	Create the ProcessInstance   Create the ProcessInstance This way of creating a process instance using this method will only work for processes in which no contract is defined.
void	deleteProcessInstanceById(String id)	Delete the ProcessInstance by ID Delete the single ProcessInstance for the given ID
void	deleteProcessInstanceByIds(List<String> requestBody)	Delete the ProcessInstance by batch   Delete a list of ProcessInstances for the given IDs
Map<String,Object>	getContextByProcessInstanceId(String id)	Finds the Context by ProcessInstance ID Returns the Context for the given ProcessInstance ID
ProcessInstance	getProcessInstanceById(String id, String n)	Finds the ProcessInstance by ID Returns the single ProcessInstance for the given ID
ProcessInstance	getProcessInstanceById(String id, Map<String,Object> queryParams)	Finds the ProcessInstance by ID Returns the single ProcessInstance for the given ID Note, this is equivalent to the other getProcessInstanceById method, but with the query parameters collected into a single Map parameter.
List<ProcessInstance>	searchProcessInstances(Integer p, Integer c, List<String> f, String o)	Finds ProcessInstances Finds ProcessInstances with pagination params and filters You can filter on: * `processDefinitionId`: The process derfinition ID * `name`: the process name * `started_by`: the ID of the user who started the process * `team_manager_id`: allow to retrieve the process instances in which all users with this manager ID ar involved) * `supervisor_id`: allow the retrived the process instances of all processes the user with this ID is supervisor of) beware you cannot use team_manager_id and supervisor_id at the same time
List<ProcessInstance>	searchProcessInstances(Map<String,Object> queryParams)	Finds ProcessInstances Finds ProcessInstances with pagination params and filters You can filter on: * `processDefinitionId`: The process derfinition ID * `name`: the process name * `started_by`: the ID of the user who started the process * `team_manager_id`: allow to retrieve the process instances in which all users with this manager ID ar involved) * `supervisor_id`: allow the retrived the process instances of all processes the user with this ID is supervisor of) beware you cannot use team_manager_id and supervisor_id at the same time Note, this is equivalent to the other searchProcessInstances method, but with the query parameters collected into a single Map parameter.

Method Detail

createProcessInstance

ProcessInstance createProcessInstance(ProcessInstanceCreateRequest body)

Create the ProcessInstance   Create the ProcessInstance This way of creating a process instance using this method will only work for processes in which no contract is defined. To instantiate a process with a contract, check the process instantiation resource documentation.

Parameters:

body - **Warning**: The attribute `variables` on the request payload is used to initialize the process variables (not BDM variables). If you want to initialize BDM variables at process instantiation, add a contract on the process and map BDM variables to the contract data. See Start a process using an instantiation contract for usage. (required)

Returns:

ProcessInstance

deleteProcessInstanceById

void deleteProcessInstanceById(String id)

Delete the ProcessInstance by ID Delete the single ProcessInstance for the given ID

Parameters:

id - ID of the ProcessInstance to delete (required)

deleteProcessInstanceByIds

void deleteProcessInstanceByIds(List<String> requestBody)

Delete the ProcessInstance by batch   Delete a list of ProcessInstances for the given IDs

Parameters:

requestBody - (optional)

getContextByProcessInstanceId

Map<String,Object> getContextByProcessInstanceId(String id)

Finds the Context by ProcessInstance ID Returns the Context for the given ProcessInstance ID

Parameters:

id - ID of the ProcessInstance that has the Context to return (required)

Returns:

Map<String, Object>

getProcessInstanceById

ProcessInstance getProcessInstanceById(String id,
                                       String n)

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

Parameters:

id - ID of the ProcessInstance to return (required)

n - Count of related resources (optional)

Returns:

ProcessInstance

getProcessInstanceById

ProcessInstance getProcessInstanceById(String id,
                                       Map<String,Object> queryParams)

Finds the ProcessInstance by ID Returns the single ProcessInstance for the given ID Note, this is equivalent to the other getProcessInstanceById 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 ProcessInstanceApi.GetProcessInstanceByIdQueryParams class that allows for building up this map in a fluent style.

Parameters:

id - ID of the ProcessInstance to return (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• n - Count of related resources (optional)

Returns:

ProcessInstance

searchProcessInstances

List<ProcessInstance> searchProcessInstances(Integer p,
                                             Integer c,
                                             List<String> f,
                                             String o)

Finds ProcessInstances Finds ProcessInstances with pagination params and filters You can filter on: * `processDefinitionId`: The process derfinition ID * `name`: the process name * `started_by`: the ID of the user who started the process * `team_manager_id`: allow to retrieve the process instances in which all users with this manager ID ar involved) * `supervisor_id`: allow the retrived the process instances of all processes the user with this ID is supervisor of) beware you cannot use team_manager_id and supervisor_id at the same time

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

searchProcessInstances

List<ProcessInstance> searchProcessInstances(Map<String,Object> queryParams)

Finds ProcessInstances Finds ProcessInstances with pagination params and filters You can filter on: * `processDefinitionId`: The process derfinition ID * `name`: the process name * `started_by`: the ID of the user who started the process * `team_manager_id`: allow to retrieve the process instances in which all users with this manager ID ar involved) * `supervisor_id`: allow the retrived the process instances of all processes the user with this ID is supervisor of) beware you cannot use team_manager_id and supervisor_id at the same time Note, this is equivalent to the other searchProcessInstances 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 ProcessInstanceApi.SearchProcessInstancesQueryParams 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<ProcessInstance>