Package org.bonitasoft.web.client.api

Interface ProfileMemberApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProfileMemberApi.SearchProfileMembersQueryParams	A convenience class for generating query parameters for the searchProfileMembers method in a fluent style.

Method Summary

Modifier and Type	Method	Description
ProfileMember	createProfileMember(ProfileMemberCreateRequest body)	Create the ProfileMember Create the ProfileMember
ApiResponse<ProfileMember>	createProfileMemberWithHttpInfo(ProfileMemberCreateRequest body)	Create the ProfileMember Similar to createProfileMember but it also returns the http response headers .
void	deleteProfileMemberById(String id)	Delete the ProfileMember by ID Delete the single ProfileMember for the given ID
ApiResponse<Void>	deleteProfileMemberByIdWithHttpInfo(String id)	Delete the ProfileMember by ID Similar to deleteProfileMemberById but it also returns the http response headers .
ProfileMember	getProfileMemberById(String id)	Finds the ProfileMember by ID Returns the single ProfileMember for the given ID
ApiResponse<ProfileMember>	getProfileMemberByIdWithHttpInfo(String id)	Finds the ProfileMember by ID Similar to getProfileMemberById but it also returns the http response headers .
List<ProfileMember>	searchProfileMembers(Integer p, Integer c, List<String> f)	Finds ProfileMembers Finds ProfileMembers with pagination params and filters **Filter `member_type` is mandatory** You can filter on `profile_id`, `user_id`, `role_id` and `group_id`
List<ProfileMember>	searchProfileMembers(Map<String,Object> queryParams)	Finds ProfileMembers Finds ProfileMembers with pagination params and filters **Filter `member_type` is mandatory** You can filter on `profile_id`, `user_id`, `role_id` and `group_id` Note, this is equivalent to the other searchProfileMembers method, but with the query parameters collected into a single Map parameter.
ApiResponse<List<ProfileMember>>	searchProfileMembersWithHttpInfo(Integer p, Integer c, List<String> f)	Finds ProfileMembers Similar to searchProfileMembers but it also returns the http response headers .
ApiResponse<List<ProfileMember>>	searchProfileMembersWithHttpInfo(Map<String,Object> queryParams)	Finds ProfileMembers Finds ProfileMembers with pagination params and filters **Filter `member_type` is mandatory** You can filter on `profile_id`, `user_id`, `role_id` and `group_id` Note, this is equivalent to the other searchProfileMembers that receives the query parameters as a map, but this one also exposes the Http response headers

Method Detail

createProfileMember

ProfileMember createProfileMember(ProfileMemberCreateRequest body)

Create the ProfileMember Create the ProfileMember

Parameters:

body - Partial ProfileMember description (required)

Returns:

ProfileMember

createProfileMemberWithHttpInfo

ApiResponse<ProfileMember> createProfileMemberWithHttpInfo(ProfileMemberCreateRequest body)

Create the ProfileMember Similar to createProfileMember but it also returns the http response headers . Create the ProfileMember

Parameters:

body - Partial ProfileMember description (required)

Returns:

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

deleteProfileMemberById

void deleteProfileMemberById(String id)

Delete the ProfileMember by ID Delete the single ProfileMember for the given ID

Parameters:

id - ID of the ProfileMember to delete (required)

deleteProfileMemberByIdWithHttpInfo

ApiResponse<Void> deleteProfileMemberByIdWithHttpInfo(String id)

Delete the ProfileMember by ID Similar to deleteProfileMemberById but it also returns the http response headers . Delete the single ProfileMember for the given ID

Parameters:

id - ID of the ProfileMember to delete (required)

getProfileMemberById

ProfileMember getProfileMemberById(String id)

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

Parameters:

id - ID of the ProfileMember to return (required)

Returns:

ProfileMember

getProfileMemberByIdWithHttpInfo

ApiResponse<ProfileMember> getProfileMemberByIdWithHttpInfo(String id)

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

Parameters:

id - ID of the ProfileMember to return (required)

Returns:

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

searchProfileMembers

List<ProfileMember> searchProfileMembers(Integer p,
                                         Integer c,
                                         List<String> f)

Finds ProfileMembers Finds ProfileMembers with pagination params and filters **Filter `member_type` is mandatory** You can filter on `profile_id`, `user_id`, `role_id` and `group_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)

Returns:

List<ProfileMember>

searchProfileMembersWithHttpInfo

ApiResponse<List<ProfileMember>> searchProfileMembersWithHttpInfo(Integer p,
                                                                  Integer c,
                                                                  List<String> f)

Finds ProfileMembers Similar to searchProfileMembers but it also returns the http response headers . Finds ProfileMembers with pagination params and filters **Filter `member_type` is mandatory** You can filter on `profile_id`, `user_id`, `role_id` and `group_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)

Returns:

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

searchProfileMembers

List<ProfileMember> searchProfileMembers(Map<String,Object> queryParams)

Finds ProfileMembers Finds ProfileMembers with pagination params and filters **Filter `member_type` is mandatory** You can filter on `profile_id`, `user_id`, `role_id` and `group_id` Note, this is equivalent to the other searchProfileMembers 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 ProfileMemberApi.SearchProfileMembersQueryParams 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)

Returns:

List<ProfileMember>

searchProfileMembersWithHttpInfo

ApiResponse<List<ProfileMember>> searchProfileMembersWithHttpInfo(Map<String,Object> queryParams)

Finds ProfileMembers Finds ProfileMembers with pagination params and filters **Filter `member_type` is mandatory** You can filter on `profile_id`, `user_id`, `role_id` and `group_id` Note, this is equivalent to the other searchProfileMembers 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)

Returns:

List<ProfileMember>