org.bonitasoft.web.client.api.RoleApi 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 createRole but it also returns the http response headers .
* Create the Role
*
* @param body Partial Role description (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /API/identity/role")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createRoleWithHttpInfo(RoleCreateRequest body);
/**
* Delete the Role by ID
* Delete the single Role for the given ID
*
* @param id ID of the Role to delete (required)
*/
@RequestLine("DELETE /API/identity/role/{id}")
@Headers({
"Accept: application/json",
})
void deleteRoleById(@Param("id") String id);
/**
* Delete the Role by ID
* Similar to deleteRoleById but it also returns the http response headers .
* Delete the single Role for the given ID
*
* @param id ID of the Role to delete (required)
*/
@RequestLine("DELETE /API/identity/role/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteRoleByIdWithHttpInfo(@Param("id") String id);
/**
* Finds the Role by ID
* Returns the single Role for the given ID
*
* @param id ID of the Role to return (required)
* @return Role
*/
@RequestLine("GET /API/identity/role/{id}")
@Headers({
"Accept: application/json",
})
Role getRoleById(@Param("id") String id);
/**
* Finds the Role by ID
* Similar to getRoleById but it also returns the http response headers .
* Returns the single Role for the given ID
*
* @param id ID of the Role to return (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/identity/role/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getRoleByIdWithHttpInfo(@Param("id") String id);
/**
* Finds Roles
* Finds Roles with pagination params and filters - can order on `id`, `name` and `displayName` - can filter on `name`
* and `displayName`
*
* @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)
* @param s can search on attributes (optional)
* @return List<Role>
*/
@RequestLine("GET /API/identity/role?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
List searchRoles(@Param("p") Integer p, @Param("c") Integer c, @Param("f") List f,
@Param("o") String o, @Param("s") String s);
/**
* Finds Roles
* Similar to searchRoles but it also returns the http response headers .
* Finds Roles with pagination params and filters - can order on `id`, `name` and `displayName` - can filter on `name`
* and `displayName`
*
* @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)
* @param s can search on attributes (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/identity/role?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchRolesWithHttpInfo(@Param("p") Integer p, @Param("c") Integer c,
@Param("f") List f, @Param("o") String o, @Param("s") String s);
/**
* Finds Roles
* Finds Roles with pagination params and filters - can order on `id`, `name` and `displayName` - can filter on `name`
* and `displayName`
* Note, this is equivalent to the other searchRoles 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 SearchRolesQueryParams} 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)
* - s - can search on attributes (optional)
*
* @return List<Role>
*/
@RequestLine("GET /API/identity/role?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
List searchRoles(@QueryMap(encoded = true) SearchRolesQueryParams queryParams);
/**
* Finds Roles
* Finds Roles with pagination params and filters - can order on `id`, `name` and `displayName` - can filter on `name`
* and `displayName`
* Note, this is equivalent to the other searchRoles 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)
* - s - can search on attributes (optional)
*
* @return List<Role>
*/
@RequestLine("GET /API/identity/role?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchRolesWithHttpInfo(@QueryMap(encoded = true) SearchRolesQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* searchRoles method in a fluent style.
*/
public static class SearchRolesQueryParams extends HashMap {
public SearchRolesQueryParams p(final Integer value) {
put("p", EncodingUtils.encode(value));
return this;
}
public SearchRolesQueryParams c(final Integer value) {
put("c", EncodingUtils.encode(value));
return this;
}
public SearchRolesQueryParams f(final List value) {
put("f", EncodingUtils.encodeCollection(value, "multi"));
return this;
}
public SearchRolesQueryParams o(final String value) {
put("o", EncodingUtils.encode(value));
return this;
}
public SearchRolesQueryParams s(final String value) {
put("s", EncodingUtils.encode(value));
return this;
}
}
/**
* Update the Role by ID
* Update the Role for the given ID
*
* @param id ID of the Role to return (required)
* @param roleUpdateRequest Partial Role description (required)
*/
@RequestLine("PUT /API/identity/role/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void updateRoleById(@Param("id") String id, RoleUpdateRequest roleUpdateRequest);
/**
* Update the Role by ID
* Similar to updateRoleById but it also returns the http response headers .
* Update the Role for the given ID
*
* @param id ID of the Role to return (required)
* @param roleUpdateRequest Partial Role description (required)
*/
@RequestLine("PUT /API/identity/role/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse updateRoleByIdWithHttpInfo(@Param("id") String id, RoleUpdateRequest roleUpdateRequest);
}