org.bonitasoft.web.client.api.ActorApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of bonita-java-client Show documentation
Show all versions of bonita-java-client Show documentation
Java client for Bonita REST API
The newest version!
/**
* Copyright (C) 2024 BonitaSoft S.A.
* BonitaSoft, 32 rue Gustave Eiffel - 38000 Grenoble
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2.0 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see getActorById but it also returns the http response headers .
* Returns the single Actor for the given ID
*
* @param id ID of the Actor to return (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/bpm/actor/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getActorByIdWithHttpInfo(@Param("id") String id);
/**
* Finds Actors
* Finds Actors with pagination params and filters
*
* @param p index of the page to display (required)
* @param c maximum number of elements to retrieve (required)
* @param f can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
* @param o can order on attributes (optional)
* @return List<Actor>
*/
@RequestLine("GET /API/bpm/actor?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
List searchActors(@Param("p") Integer p, @Param("c") Integer c, @Param("f") List f,
@Param("o") String o);
/**
* Finds Actors
* Similar to searchActors but it also returns the http response headers .
* Finds Actors with pagination params and filters
*
* @param p index of the page to display (required)
* @param c maximum number of elements to retrieve (required)
* @param f can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
* @param o can order on attributes (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/bpm/actor?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchActorsWithHttpInfo(@Param("p") Integer p, @Param("c") Integer c,
@Param("f") List f, @Param("o") String o);
/**
* 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 {@link SearchActorsQueryParams} class that allows for
* building up this map in a fluent style.
*
* @param 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)
*
* @return List<Actor>
*/
@RequestLine("GET /API/bpm/actor?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
List searchActors(@QueryMap(encoded = true) 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
*
* @param 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)
*
* @return List<Actor>
*/
@RequestLine("GET /API/bpm/actor?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchActorsWithHttpInfo(@QueryMap(encoded = true) SearchActorsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* searchActors method in a fluent style.
*/
public static class SearchActorsQueryParams extends HashMap {
public SearchActorsQueryParams p(final Integer value) {
put("p", EncodingUtils.encode(value));
return this;
}
public SearchActorsQueryParams c(final Integer value) {
put("c", EncodingUtils.encode(value));
return this;
}
public SearchActorsQueryParams f(final List value) {
put("f", EncodingUtils.encodeCollection(value, "multi"));
return this;
}
public SearchActorsQueryParams o(final String value) {
put("o", EncodingUtils.encode(value));
return this;
}
}
/**
* 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.
*
* @param id ID of the Actor to return (required)
* @param actorUpdateRequest Fields that can be upated are `displayName` and `description` (required)
* @deprecated
*/
@Deprecated
@RequestLine("PUT /API/bpm/actor/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void updateActorById(@Param("id") String id, ActorUpdateRequest actorUpdateRequest);
/**
* 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.
*
* @param id ID of the Actor to return (required)
* @param actorUpdateRequest Fields that can be upated are `displayName` and `description` (required)
* @deprecated
*/
@Deprecated
@RequestLine("PUT /API/bpm/actor/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse updateActorByIdWithHttpInfo(@Param("id") String id, ActorUpdateRequest actorUpdateRequest);
}