Package org.bonitasoft.web.client.api

Interface MembershipApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MembershipApi.SearchMembershipsQueryParams	A convenience class for generating query parameters for the searchMemberships method in a fluent style.

Method Summary

Modifier and Type	Method	Description
Membership	createMembership(MembershipCreateRequest body)	Create the Membership Create the Membership
ApiResponse<Membership>	createMembershipWithHttpInfo(MembershipCreateRequest body)	Create the Membership Similar to createMembership but it also returns the http response headers .
void	deleteMembershipById(String userId, String groupId, String roleId)	Delete the Membership by ID Delete a membership of a user using the group id and role id.
ApiResponse<Void>	deleteMembershipByIdWithHttpInfo(String userId, String groupId, String roleId)	Delete the Membership by ID Similar to deleteMembershipById but it also returns the http response headers .
List<Membership>	searchMemberships(Integer p, Integer c, List<String> f, String o, String s)	Finds Memberships Finds Memberships with pagination params and filters **Filter `user_id` is mandatory** You can order with the values: `ROLE_NAME_ASC`,`ROLE_NAME_DESC`, `GROUP_NAME_ASC`,`GROUP_NAME_DESC`, `ASSIGNED_DATE_ASC`, `ASSIGNED_DATE_DESC`
List<Membership>	searchMemberships(Map<String,Object> queryParams)	Finds Memberships Finds Memberships with pagination params and filters **Filter `user_id` is mandatory** You can order with the values: `ROLE_NAME_ASC`,`ROLE_NAME_DESC`, `GROUP_NAME_ASC`,`GROUP_NAME_DESC`, `ASSIGNED_DATE_ASC`, `ASSIGNED_DATE_DESC` Note, this is equivalent to the other searchMemberships method, but with the query parameters collected into a single Map parameter.
ApiResponse<List<Membership>>	searchMembershipsWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)	Finds Memberships Similar to searchMemberships but it also returns the http response headers .
ApiResponse<List<Membership>>	searchMembershipsWithHttpInfo(Map<String,Object> queryParams)	Finds Memberships Finds Memberships with pagination params and filters **Filter `user_id` is mandatory** You can order with the values: `ROLE_NAME_ASC`,`ROLE_NAME_DESC`, `GROUP_NAME_ASC`,`GROUP_NAME_DESC`, `ASSIGNED_DATE_ASC`, `ASSIGNED_DATE_DESC` Note, this is equivalent to the other searchMemberships that receives the query parameters as a map, but this one also exposes the Http response headers

Method Detail

createMembership

Membership createMembership(MembershipCreateRequest body)

Create the Membership Create the Membership

Parameters:

body - Partial Membership description (required)

Returns:

Membership

createMembershipWithHttpInfo

ApiResponse<Membership> createMembershipWithHttpInfo(MembershipCreateRequest body)

Create the Membership Similar to createMembership but it also returns the http response headers . Create the Membership

Parameters:

body - Partial Membership description (required)

Returns:

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

deleteMembershipById

void deleteMembershipById(String userId,
                          String groupId,
                          String roleId)

Delete the Membership by ID Delete a membership of a user using the group id and role id.

Parameters:

userId - User ID of the Membership to delete (required)

groupId - Group ID of the Membership to delete (required)

roleId - Role ID of the Membership to delete (required)

deleteMembershipByIdWithHttpInfo

ApiResponse<Void> deleteMembershipByIdWithHttpInfo(String userId,
                                                   String groupId,
                                                   String roleId)

Delete the Membership by ID Similar to deleteMembershipById but it also returns the http response headers . Delete a membership of a user using the group id and role id.

Parameters:

userId - User ID of the Membership to delete (required)

groupId - Group ID of the Membership to delete (required)

roleId - Role ID of the Membership to delete (required)

searchMemberships

List<Membership> searchMemberships(Integer p,
                                   Integer c,
                                   List<String> f,
                                   String o,
                                   String s)

Finds Memberships Finds Memberships with pagination params and filters **Filter `user_id` is mandatory** You can order with the values: `ROLE_NAME_ASC`,`ROLE_NAME_DESC`, `GROUP_NAME_ASC`,`GROUP_NAME_DESC`, `ASSIGNED_DATE_ASC`, `ASSIGNED_DATE_DESC`

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

searchMembershipsWithHttpInfo

ApiResponse<List<Membership>> searchMembershipsWithHttpInfo(Integer p,
                                                            Integer c,
                                                            List<String> f,
                                                            String o,
                                                            String s)

Finds Memberships Similar to searchMemberships but it also returns the http response headers . Finds Memberships with pagination params and filters **Filter `user_id` is mandatory** You can order with the values: `ROLE_NAME_ASC`,`ROLE_NAME_DESC`, `GROUP_NAME_ASC`,`GROUP_NAME_DESC`, `ASSIGNED_DATE_ASC`, `ASSIGNED_DATE_DESC`

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.

searchMemberships

List<Membership> searchMemberships(Map<String,Object> queryParams)

Finds Memberships Finds Memberships with pagination params and filters **Filter `user_id` is mandatory** You can order with the values: `ROLE_NAME_ASC`,`ROLE_NAME_DESC`, `GROUP_NAME_ASC`,`GROUP_NAME_DESC`, `ASSIGNED_DATE_ASC`, `ASSIGNED_DATE_DESC` Note, this is equivalent to the other searchMemberships 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 MembershipApi.SearchMembershipsQueryParams 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<Membership>

searchMembershipsWithHttpInfo

ApiResponse<List<Membership>> searchMembershipsWithHttpInfo(Map<String,Object> queryParams)

Finds Memberships Finds Memberships with pagination params and filters **Filter `user_id` is mandatory** You can order with the values: `ROLE_NAME_ASC`,`ROLE_NAME_DESC`, `GROUP_NAME_ASC`,`GROUP_NAME_DESC`, `ASSIGNED_DATE_ASC`, `ASSIGNED_DATE_DESC` Note, this is equivalent to the other searchMemberships 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<Membership>