Package org.bonitasoft.web.client.api

Interface ActorApi

All Superinterfaces:

ApiClient.Api

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.12.0")
public interface ActorApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ActorApi.SearchActorsQueryParams	A convenience class for generating query parameters for the searchActors method in a fluent style.

Method Summary

Modifier and Type	Method	Description
Actor	getActorById(String id)	Finds the Actor by ID Returns the single Actor for the given ID
ApiResponse<Actor>	getActorByIdWithHttpInfo(String id)	Finds the Actor by ID Similar to getActorById but it also returns the http response headers .
List<Actor>	searchActors(Integer p, Integer c, List<String> f, String o)	Finds Actors Finds Actors with pagination params and filters
List<Actor>	searchActors(ActorApi.SearchActorsQueryParams queryParams)	Finds Actors Finds Actors with pagination params and filters Note, this is equivalent to the other searchActors method, but with the query parameters collected into a single Map parameter.
ApiResponse<List<Actor>>	searchActorsWithHttpInfo(Integer p, Integer c, List<String> f, String o)	Finds Actors Similar to searchActors but it also returns the http response headers .
ApiResponse<List<Actor>>	searchActorsWithHttpInfo(ActorApi.SearchActorsQueryParams queryParams)	Finds Actors Finds Actors with pagination params and filters Note, this is equivalent to the other searchActors that receives the query parameters as a map, but this one also exposes the Http response headers
void	updateActorById(String id, ActorUpdateRequest actorUpdateRequest)	Deprecated.
ApiResponse<Void>	updateActorByIdWithHttpInfo(String id, ActorUpdateRequest actorUpdateRequest)	Deprecated.

Method Details

getActorById

Actor getActorById(String id)

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

Parameters:

id - ID of the Actor to return (required)

Returns:

Actor

getActorByIdWithHttpInfo

ApiResponse<Actor> getActorByIdWithHttpInfo(String id)

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

Parameters:

id - ID of the Actor to return (required)

Returns:

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

searchActors

List<Actor> searchActors(Integer p,
 Integer c,
 List<String> f,
 String o)

Finds Actors Finds Actors with pagination params and filters

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

searchActorsWithHttpInfo

ApiResponse<List<Actor>> searchActorsWithHttpInfo(Integer p,
 Integer c,
 List<String> f,
 String o)

Finds Actors Similar to searchActors but it also returns the http response headers . Finds Actors with pagination params and filters

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:

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

searchActors

List<Actor> searchActors(ActorApi.SearchActorsQueryParams queryParams)

Finds Actors Finds Actors with pagination params and filters Note, this is equivalent to the other searchActors 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 ActorApi.SearchActorsQueryParams 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<Actor>

searchActorsWithHttpInfo

ApiResponse<List<Actor>> searchActorsWithHttpInfo(ActorApi.SearchActorsQueryParams queryParams)

Finds Actors Finds Actors with pagination params and filters Note, this is equivalent to the other searchActors 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)

Returns:

List<Actor>

updateActorById

@Deprecated
void updateActorById(String id,
 ActorUpdateRequest actorUpdateRequest)

Deprecated.

Update the Actor by ID Update the Actor for the given ID Warning: as of 9.0.0, updating an Actor using this API is deprecated.

Parameters:

id - ID of the Actor to return (required)

actorUpdateRequest - Fields that can be upated are `displayName` and `description` (required)

updateActorByIdWithHttpInfo

@Deprecated
ApiResponse<Void> updateActorByIdWithHttpInfo(String id,
 ActorUpdateRequest actorUpdateRequest)

Deprecated.

Update the Actor by ID Similar to updateActorById but it also returns the http response headers . Update the Actor for the given ID Warning: as of 9.0.0, updating an Actor using this API is deprecated.

Parameters:

id - ID of the Actor to return (required)

actorUpdateRequest - Fields that can be upated are `displayName` and `description` (required)