Package org.bonitasoft.web.client.api

Interface ActorMemberApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ActorMemberApi.SearchActorMembersQueryParams	A convenience class for generating query parameters for the searchActorMembers method in a fluent style.

Method Summary

Modifier and Type	Method	Description
void	deleteActorMemberById(String id)	Delete the ActorMember by ID Delete the single ActorMember for the given ID
ActorMember	getActorMemberById(String id)	Finds the ActorMember by ID Returns the single ActorMember for the given ID
List<ActorMember>	searchActorMembers(Integer p, Integer c, List<String> f, String o)	Finds ActorMembers Finds ActorMembers with pagination params and filters There is a **mandatory** filter on: * `actor_id` For example, retrieve the actorMembers related to the specified actor_id.
List<ActorMember>	searchActorMembers(Map<String,Object> queryParams)	Finds ActorMembers Finds ActorMembers with pagination params and filters There is a **mandatory** filter on: * `actor_id` For example, retrieve the actorMembers related to the specified actor_id.

Method Detail

deleteActorMemberById

void deleteActorMemberById(String id)

Delete the ActorMember by ID Delete the single ActorMember for the given ID

Parameters:

id - ID of the ActorMember to delete (required)

getActorMemberById

ActorMember getActorMemberById(String id)

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

Parameters:

id - ID of the ActorMember to return (required)

Returns:

ActorMember

searchActorMembers

List<ActorMember> searchActorMembers(Integer p,
                                     Integer c,
                                     List<String> f,
                                     String o)

Finds ActorMembers Finds ActorMembers with pagination params and filters There is a **mandatory** filter on: * `actor_id` For example, retrieve the actorMembers related to the specified actor_id. http://localhost:8080/bonita/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1 You can also filter also on: * `member_type` (user|role|group|roleAndGroup) retrieve only the actorMembers of type user. `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=member_type%3duser` * `user_id`: retrieve only the actorMembers related to the specified user_id. `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=user_id%3d101` * `role_id`: retrieve only the actorMembers related to the specified role_id. `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=role_id%3d101` * `group_id`: retrieve only the actorMembers related to the specified group_id. `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=group_id%3d101`

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)

Returns:

List<ActorMember>

searchActorMembers

List<ActorMember> searchActorMembers(Map<String,Object> queryParams)

Finds ActorMembers Finds ActorMembers with pagination params and filters There is a **mandatory** filter on: * `actor_id` For example, retrieve the actorMembers related to the specified actor_id. http://localhost:8080/bonita/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1 You can also filter also on: * `member_type` (user|role|group|roleAndGroup) retrieve only the actorMembers of type user. `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=member_type%3duser` * `user_id`: retrieve only the actorMembers related to the specified user_id. `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=user_id%3d101` * `role_id`: retrieve only the actorMembers related to the specified role_id. `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=role_id%3d101` * `group_id`: retrieve only the actorMembers related to the specified group_id. `/API/bpm/actorMember?p=0&c=10&f=actor_id%3d1&f=group_id%3d101` Note, this is equivalent to the other searchActorMembers 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 ActorMemberApi.SearchActorMembersQueryParams 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)

Returns:

List<ActorMember>