org.bonitasoft.web.client.api.ProfileMemberApi 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 createProfileMember but it also returns the http response headers .
* Create the ProfileMember
*
* @param body Partial ProfileMember description (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /API/portal/profileMember")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createProfileMemberWithHttpInfo(ProfileMemberCreateRequest body);
/**
* Delete the ProfileMember by ID
* Delete the single ProfileMember for the given ID
*
* @param id ID of the ProfileMember to delete (required)
*/
@RequestLine("DELETE /API/portal/profileMember/{id}")
@Headers({
"Accept: application/json",
})
void deleteProfileMemberById(@Param("id") String id);
/**
* Delete the ProfileMember by ID
* Similar to deleteProfileMemberById but it also returns the http response headers .
* Delete the single ProfileMember for the given ID
*
* @param id ID of the ProfileMember to delete (required)
*/
@RequestLine("DELETE /API/portal/profileMember/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteProfileMemberByIdWithHttpInfo(@Param("id") String id);
/**
* Finds the ProfileMember by ID
* Returns the single ProfileMember for the given ID
*
* @param id ID of the ProfileMember to return (required)
* @return ProfileMember
*/
@RequestLine("GET /API/portal/profileMember/{id}")
@Headers({
"Accept: application/json",
})
ProfileMember getProfileMemberById(@Param("id") String id);
/**
* Finds the ProfileMember by ID
* Similar to getProfileMemberById but it also returns the http response headers .
* Returns the single ProfileMember for the given ID
*
* @param id ID of the ProfileMember to return (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/portal/profileMember/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getProfileMemberByIdWithHttpInfo(@Param("id") String id);
/**
* Finds ProfileMembers
* Finds ProfileMembers with pagination params and filters **Filter `member_type` is mandatory** You can filter on `profile_id`,
* `user_id`, `role_id` and `group_id`
*
* @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)
* @return List<ProfileMember>
*/
@RequestLine("GET /API/portal/profileMember?p={p}&c={c}&f={f}")
@Headers({
"Accept: application/json",
})
List searchProfileMembers(@Param("p") Integer p, @Param("c") Integer c, @Param("f") List f);
/**
* Finds ProfileMembers
* Similar to searchProfileMembers but it also returns the http response headers .
* Finds ProfileMembers with pagination params and filters **Filter `member_type` is mandatory** You can filter on `profile_id`,
* `user_id`, `role_id` and `group_id`
*
* @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)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/portal/profileMember?p={p}&c={c}&f={f}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchProfileMembersWithHttpInfo(@Param("p") Integer p, @Param("c") Integer c,
@Param("f") List f);
/**
* Finds ProfileMembers
* Finds ProfileMembers with pagination params and filters **Filter `member_type` is mandatory** You can filter on `profile_id`,
* `user_id`, `role_id` and `group_id`
* Note, this is equivalent to the other searchProfileMembers 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 SearchProfileMembersQueryParams} 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)
*
* @return List<ProfileMember>
*/
@RequestLine("GET /API/portal/profileMember?p={p}&c={c}&f={f}")
@Headers({
"Accept: application/json",
})
List searchProfileMembers(@QueryMap(encoded = true) SearchProfileMembersQueryParams queryParams);
/**
* Finds ProfileMembers
* Finds ProfileMembers with pagination params and filters **Filter `member_type` is mandatory** You can filter on `profile_id`,
* `user_id`, `role_id` and `group_id`
* Note, this is equivalent to the other searchProfileMembers 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)
*
* @return List<ProfileMember>
*/
@RequestLine("GET /API/portal/profileMember?p={p}&c={c}&f={f}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchProfileMembersWithHttpInfo(
@QueryMap(encoded = true) SearchProfileMembersQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* searchProfileMembers method in a fluent style.
*/
public static class SearchProfileMembersQueryParams extends HashMap {
public SearchProfileMembersQueryParams p(final Integer value) {
put("p", EncodingUtils.encode(value));
return this;
}
public SearchProfileMembersQueryParams c(final Integer value) {
put("c", EncodingUtils.encode(value));
return this;
}
public SearchProfileMembersQueryParams f(final List value) {
put("f", EncodingUtils.encodeCollection(value, "multi"));
return this;
}
}
}