Package org.bonitasoft.web.client.api

Interface ProcessParameterApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProcessParameterApi.SearchProcessParametersQueryParams	A convenience class for generating query parameters for the searchProcessParameters method in a fluent style.

Method Summary

Modifier and Type	Method	Description
ProcessParameter	getProcessParameterById(String id, String name)	Finds the ProcessParameter by ID Returns the single ProcessParameter for the given ID
ApiResponse<ProcessParameter>	getProcessParameterByIdWithHttpInfo(String id, String name)	Finds the ProcessParameter by ID Similar to getProcessParameterById but it also returns the http response headers .
List<ProcessParameter>	searchProcessParameters(Integer p, Integer c, List<String> f, String o, String s)	Finds ProcessParameters Finds ProcessParameters with pagination params and filters.
List<ProcessParameter>	searchProcessParameters(Map<String,Object> queryParams)	Finds ProcessParameters Finds ProcessParameters with pagination params and filters.
ApiResponse<List<ProcessParameter>>	searchProcessParametersWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)	Finds ProcessParameters Similar to searchProcessParameters but it also returns the http response headers .
ApiResponse<List<ProcessParameter>>	searchProcessParametersWithHttpInfo(Map<String,Object> queryParams)	Finds ProcessParameters Finds ProcessParameters with pagination params and filters.
void	updateProcessParameterById(String id, String name, ProcessParameterUpdateRequest processParameterUpdateRequest)	Update the ProcessParameter by ID  Update the ProcessParameter for the given ID
ApiResponse<Void>	updateProcessParameterByIdWithHttpInfo(String id, String name, ProcessParameterUpdateRequest processParameterUpdateRequest)	Update the ProcessParameter by ID Similar to updateProcessParameterById but it also returns the http response headers .

Method Detail

getProcessParameterById

ProcessParameter getProcessParameterById(String id,
                                         String name)

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

Parameters:

id - ID of the process to get parameter from (required)

name - Name of the process parameter to return (required)

Returns:

ProcessParameter

getProcessParameterByIdWithHttpInfo

ApiResponse<ProcessParameter> getProcessParameterByIdWithHttpInfo(String id,
                                                                  String name)

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

Parameters:

id - ID of the process to get parameter from (required)

name - Name of the process parameter to return (required)

Returns:

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

searchProcessParameters

List<ProcessParameter> searchProcessParameters(Integer p,
                                               Integer c,
                                               List<String> f,
                                               String o,
                                               String s)

Finds ProcessParameters Finds ProcessParameters with pagination params and filters.

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

searchProcessParametersWithHttpInfo

ApiResponse<List<ProcessParameter>> searchProcessParametersWithHttpInfo(Integer p,
                                                                        Integer c,
                                                                        List<String> f,
                                                                        String o,
                                                                        String s)

Finds ProcessParameters Similar to searchProcessParameters but it also returns the http response headers . Finds ProcessParameters with pagination params and filters.

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.

searchProcessParameters

List<ProcessParameter> searchProcessParameters(Map<String,Object> queryParams)

Finds ProcessParameters Finds ProcessParameters with pagination params and filters. Note, this is equivalent to the other searchProcessParameters 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 ProcessParameterApi.SearchProcessParametersQueryParams 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<ProcessParameter>

searchProcessParametersWithHttpInfo

ApiResponse<List<ProcessParameter>> searchProcessParametersWithHttpInfo(Map<String,Object> queryParams)

Finds ProcessParameters Finds ProcessParameters with pagination params and filters. Note, this is equivalent to the other searchProcessParameters 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<ProcessParameter>

updateProcessParameterById

void updateProcessParameterById(String id,
                                String name,
                                ProcessParameterUpdateRequest processParameterUpdateRequest)

Update the ProcessParameter by ID  Update the ProcessParameter for the given ID

Parameters:

id - ID of the process to get parameter from (required)

name - Name of the process parameter to return (required)

processParameterUpdateRequest - You can update only a process parameter value using the API. If you specify values for other fields in the update request, they are ignored. (required)

updateProcessParameterByIdWithHttpInfo

ApiResponse<Void> updateProcessParameterByIdWithHttpInfo(String id,
                                                         String name,
                                                         ProcessParameterUpdateRequest processParameterUpdateRequest)

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

Parameters:

id - ID of the process to get parameter from (required)

name - Name of the process parameter to return (required)

processParameterUpdateRequest - You can update only a process parameter value using the API. If you specify values for other fields in the update request, they are ignored. (required)