Package org.bonitasoft.web.client.api

Interface FormMappingApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FormMappingApi.SearchFormMappingsQueryParams	A convenience class for generating query parameters for the searchFormMappings method in a fluent style.

Method Summary

Modifier and Type	Method	Description
List<FormMapping>	searchFormMappings(Integer p, Integer c, List<String> f, String o, String s)	Finds FormMappings Finds FormMappings with pagination params and filters - can filter on `processDefinitionId`,`type`
List<FormMapping>	searchFormMappings(Map<String,Object> queryParams)	Finds FormMappings Finds FormMappings with pagination params and filters - can filter on `processDefinitionId`,`type` Note, this is equivalent to the other searchFormMappings method, but with the query parameters collected into a single Map parameter.
ApiResponse<List<FormMapping>>	searchFormMappingsWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)	Finds FormMappings Similar to searchFormMappings but it also returns the http response headers .
ApiResponse<List<FormMapping>>	searchFormMappingsWithHttpInfo(Map<String,Object> queryParams)	Finds FormMappings Finds FormMappings with pagination params and filters - can filter on `processDefinitionId`,`type` Note, this is equivalent to the other searchFormMappings that receives the query parameters as a map, but this one also exposes the Http response headers
void	updateFormMappingById(String id, FormMappingUpdateRequest formMappingUpdateRequest)	Update the FormMapping by ID  Update the FormMapping for the given ID
ApiResponse<Void>	updateFormMappingByIdWithHttpInfo(String id, FormMappingUpdateRequest formMappingUpdateRequest)	Update the FormMapping by ID Similar to updateFormMappingById but it also returns the http response headers .

Method Detail

searchFormMappings

List<FormMapping> searchFormMappings(Integer p,
                                     Integer c,
                                     List<String> f,
                                     String o,
                                     String s)

Finds FormMappings Finds FormMappings with pagination params and filters - can filter on `processDefinitionId`,`type`

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

searchFormMappingsWithHttpInfo

ApiResponse<List<FormMapping>> searchFormMappingsWithHttpInfo(Integer p,
                                                              Integer c,
                                                              List<String> f,
                                                              String o,
                                                              String s)

Finds FormMappings Similar to searchFormMappings but it also returns the http response headers . Finds FormMappings with pagination params and filters - can filter on `processDefinitionId`,`type`

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.

searchFormMappings

List<FormMapping> searchFormMappings(Map<String,Object> queryParams)

Finds FormMappings Finds FormMappings with pagination params and filters - can filter on `processDefinitionId`,`type` Note, this is equivalent to the other searchFormMappings 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 FormMappingApi.SearchFormMappingsQueryParams 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<FormMapping>

searchFormMappingsWithHttpInfo

ApiResponse<List<FormMapping>> searchFormMappingsWithHttpInfo(Map<String,Object> queryParams)

Finds FormMappings Finds FormMappings with pagination params and filters - can filter on `processDefinitionId`,`type` Note, this is equivalent to the other searchFormMappings 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<FormMapping>

updateFormMappingById

void updateFormMappingById(String id,
                           FormMappingUpdateRequest formMappingUpdateRequest)

Update the FormMapping by ID  Update the FormMapping for the given ID

Parameters:

id - ID of the FormMapping to return (required)

formMappingUpdateRequest - Representation of the form mapping attribute to update - {'pageId': (long)} or {'url': (string)} or {} to set the mapping type to NONE (required)

updateFormMappingByIdWithHttpInfo

ApiResponse<Void> updateFormMappingByIdWithHttpInfo(String id,
                                                    FormMappingUpdateRequest formMappingUpdateRequest)

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

Parameters:

id - ID of the FormMapping to return (required)

formMappingUpdateRequest - Representation of the form mapping attribute to update - {'pageId': (long)} or {'url': (string)} or {} to set the mapping type to NONE (required)