Package org.bonitasoft.web.client.api

Interface ProfileEntryApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProfileEntryApi.SearchProfileEntriesQueryParams	A convenience class for generating query parameters for the searchProfileEntries method in a fluent style.

Method Summary

Modifier and Type	Method	Description
ProfileEntry	createProfileEntry(ProfileEntryCreateRequest body)	Create the ProfileEntry Create the ProfileEntry
void	deleteProfileEntryById(String id)	Delete the ProfileEntry by ID Delete the single ProfileEntry for the given ID
ProfileEntry	getProfileEntryById(String id)	Finds the ProfileEntry by ID Returns the single ProfileEntry for the given ID
List<ProfileEntry>	searchProfileEntries(Integer p, Integer c, List<String> f, String s)	Finds ProfileEntries Finds ProfileEntries with pagination params and filters - can search on `name` - can filter on `page`,`name` and `parent_id`
List<ProfileEntry>	searchProfileEntries(Map<String,Object> queryParams)	Finds ProfileEntries Finds ProfileEntries with pagination params and filters - can search on `name` - can filter on `page`,`name` and `parent_id` Note, this is equivalent to the other searchProfileEntries method, but with the query parameters collected into a single Map parameter.
void	updateProfileEntryById(String id, ProfileEntryUpdateRequest profileEntryUpdateRequest)	Update the ProfileEntry by ID Update the ProfileEntry for the given ID

Method Detail

createProfileEntry

ProfileEntry createProfileEntry(ProfileEntryCreateRequest body)

Create the ProfileEntry Create the ProfileEntry

Parameters:

body - Partial ProfileEntry description (required)

Returns:

ProfileEntry

deleteProfileEntryById

void deleteProfileEntryById(String id)

Delete the ProfileEntry by ID Delete the single ProfileEntry for the given ID

Parameters:

id - ID of the ProfileEntry to delete (required)

getProfileEntryById

ProfileEntry getProfileEntryById(String id)

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

Parameters:

id - ID of the ProfileEntry to return (required)

Returns:

ProfileEntry

searchProfileEntries

List<ProfileEntry> searchProfileEntries(Integer p,
                                        Integer c,
                                        List<String> f,
                                        String s)

Finds ProfileEntries Finds ProfileEntries with pagination params and filters - can search on `name` - can filter on `page`,`name` and `parent_id`

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)

s - can search on attributes (optional)

Returns:

List<ProfileEntry>

searchProfileEntries

List<ProfileEntry> searchProfileEntries(Map<String,Object> queryParams)

Finds ProfileEntries Finds ProfileEntries with pagination params and filters - can search on `name` - can filter on `page`,`name` and `parent_id` Note, this is equivalent to the other searchProfileEntries 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 ProfileEntryApi.SearchProfileEntriesQueryParams 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)
• s - can search on attributes (optional)

Returns:

List<ProfileEntry>

updateProfileEntryById

void updateProfileEntryById(String id,
                            ProfileEntryUpdateRequest profileEntryUpdateRequest)

Update the ProfileEntry by ID Update the ProfileEntry for the given ID

Parameters:

id - ID of the ProfileEntry to return (required)

profileEntryUpdateRequest - Partial ProfileEntry description (required)