Package org.bonitasoft.web.client.api

Interface ArchivedProcessInstanceVariableApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ArchivedProcessInstanceVariableApi.GetArchivedProcessInstanceVariablesQueryParams	A convenience class for generating query parameters for the getArchivedProcessInstanceVariables method in a fluent style.

Method Summary

Modifier and Type	Method	Description
List<ArchivedProcessInstanceVariable>	getArchivedProcessInstanceVariables(Integer p, Integer c, String f)	Finds ArchivedProcessInstance Variables Since 2022.1 Finds ArchivedProcessInstance Variables with pagination params and filters
List<ArchivedProcessInstanceVariable>	getArchivedProcessInstanceVariables(Map<String,Object> queryParams)	Finds ArchivedProcessInstance Variables Since 2022.1 Finds ArchivedProcessInstance Variables with pagination params and filters Note, this is equivalent to the other getArchivedProcessInstanceVariables method, but with the query parameters collected into a single Map parameter.
ApiResponse<List<ArchivedProcessInstanceVariable>>	getArchivedProcessInstanceVariablesWithHttpInfo(Integer p, Integer c, String f)	Finds ArchivedProcessInstance Variables Similar to getArchivedProcessInstanceVariables but it also returns the http response headers .
ApiResponse<List<ArchivedProcessInstanceVariable>>	getArchivedProcessInstanceVariablesWithHttpInfo(Map<String,Object> queryParams)	Finds ArchivedProcessInstance Variables Since 2022.1 Finds ArchivedProcessInstance Variables with pagination params and filters Note, this is equivalent to the other getArchivedProcessInstanceVariables that receives the query parameters as a map, but this one also exposes the Http response headers
ArchivedProcessInstanceVariable	getArchivedVariableByProcessInstance(String id, String variableName)	Finds an archived Variable by ProcessInstance ID and variable name Since 2022.1 Returns the single ArchivedProcessInstanceVariable for the given ProcessInstance ID and variable name
ApiResponse<ArchivedProcessInstanceVariable>	getArchivedVariableByProcessInstanceWithHttpInfo(String id, String variableName)	Finds an archived Variable by ProcessInstance ID and variable name Similar to getArchivedVariableByProcessInstance but it also returns the http response headers .

Method Detail

getArchivedProcessInstanceVariables

List<ArchivedProcessInstanceVariable> getArchivedProcessInstanceVariables(Integer p,
                                                                          Integer c,
                                                                          String f)

Finds ArchivedProcessInstance Variables Since 2022.1 Finds ArchivedProcessInstance Variables with pagination params and filters

Parameters:

p - index of the page to display (required)

c - maximum number of elements to retrieve (required)

f - Filter for the case id before it was archived (eg: case_id=10001 ) (required)

Returns:

List<ArchivedProcessInstanceVariable>

getArchivedProcessInstanceVariablesWithHttpInfo

ApiResponse<List<ArchivedProcessInstanceVariable>> getArchivedProcessInstanceVariablesWithHttpInfo(Integer p,
                                                                                                   Integer c,
                                                                                                   String f)

Finds ArchivedProcessInstance Variables Similar to getArchivedProcessInstanceVariables but it also returns the http response headers . Since 2022.1 Finds ArchivedProcessInstance Variables with pagination params and filters

Parameters:

p - index of the page to display (required)

c - maximum number of elements to retrieve (required)

f - Filter for the case id before it was archived (eg: case_id=10001 ) (required)

Returns:

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

getArchivedProcessInstanceVariables

List<ArchivedProcessInstanceVariable> getArchivedProcessInstanceVariables(Map<String,Object> queryParams)

Finds ArchivedProcessInstance Variables Since 2022.1 Finds ArchivedProcessInstance Variables with pagination params and filters Note, this is equivalent to the other getArchivedProcessInstanceVariables 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 ArchivedProcessInstanceVariableApi.GetArchivedProcessInstanceVariablesQueryParams 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 - Filter for the case id before it was archived (eg: case_id=10001 ) (required)

Returns:

List<ArchivedProcessInstanceVariable>

getArchivedProcessInstanceVariablesWithHttpInfo

ApiResponse<List<ArchivedProcessInstanceVariable>> getArchivedProcessInstanceVariablesWithHttpInfo(Map<String,Object> queryParams)

Finds ArchivedProcessInstance Variables Since 2022.1 Finds ArchivedProcessInstance Variables with pagination params and filters Note, this is equivalent to the other getArchivedProcessInstanceVariables 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 - Filter for the case id before it was archived (eg: case_id=10001 ) (required)

Returns:

List<ArchivedProcessInstanceVariable>

getArchivedVariableByProcessInstance

ArchivedProcessInstanceVariable getArchivedVariableByProcessInstance(String id,
                                                                     String variableName)

Finds an archived Variable by ProcessInstance ID and variable name Since 2022.1 Returns the single ArchivedProcessInstanceVariable for the given ProcessInstance ID and variable name

Parameters:

id - The identifier of the process instance from which to retrieve the archived variable (required)

variableName - The name of the archived variable to retrieve (required)

Returns:

ArchivedProcessInstanceVariable

getArchivedVariableByProcessInstanceWithHttpInfo

ApiResponse<ArchivedProcessInstanceVariable> getArchivedVariableByProcessInstanceWithHttpInfo(String id,
                                                                                              String variableName)

Finds an archived Variable by ProcessInstance ID and variable name Similar to getArchivedVariableByProcessInstance but it also returns the http response headers . Since 2022.1 Returns the single ArchivedProcessInstanceVariable for the given ProcessInstance ID and variable name

Parameters:

id - The identifier of the process instance from which to retrieve the archived variable (required)

variableName - The name of the archived variable to retrieve (required)

Returns:

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