org.bonitasoft.web.client.api.ProfileEntryApi 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 createProfileEntry but it also returns the http response headers .
* Create the ProfileEntry Warning: Since Bonita 7.13, ProfileEntry is deprecated
*
* @param body Partial ProfileEntry description (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
* @deprecated
*/
@Deprecated
@RequestLine("POST /API/portal/profileEntry")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createProfileEntryWithHttpInfo(ProfileEntryCreateRequest body);
/**
* Delete the ProfileEntry by ID
* Delete the single ProfileEntry for the given ID
*
* @param id ID of the ProfileEntry to delete (required)
* @deprecated
*/
@Deprecated
@RequestLine("DELETE /API/portal/profileEntry/{id}")
@Headers({
"Accept: application/json",
})
void deleteProfileEntryById(@Param("id") String id);
/**
* Delete the ProfileEntry by ID
* Similar to deleteProfileEntryById but it also returns the http response headers .
* Delete the single ProfileEntry for the given ID
*
* @param id ID of the ProfileEntry to delete (required)
* @deprecated
*/
@Deprecated
@RequestLine("DELETE /API/portal/profileEntry/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteProfileEntryByIdWithHttpInfo(@Param("id") String id);
/**
* Finds the ProfileEntry by ID
* Returns the single ProfileEntry for the given ID Warning: Since Bonita 7.13, ProfileEntry is deprecated
*
* @param id ID of the ProfileEntry to return (required)
* @return ProfileEntry
* @deprecated
*/
@Deprecated
@RequestLine("GET /API/portal/profileEntry/{id}")
@Headers({
"Accept: application/json",
})
ProfileEntry getProfileEntryById(@Param("id") String id);
/**
* Finds the ProfileEntry by ID
* Similar to getProfileEntryById but it also returns the http response headers .
* Returns the single ProfileEntry for the given ID Warning: Since Bonita 7.13, ProfileEntry is deprecated
*
* @param id ID of the ProfileEntry to return (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
* @deprecated
*/
@Deprecated
@RequestLine("GET /API/portal/profileEntry/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getProfileEntryByIdWithHttpInfo(@Param("id") String id);
/**
* Finds ProfileEntries
* Finds ProfileEntries with pagination params and filters - can search on `name` - can filter on `page`,`name` and
* `parent_id` Warning: Since Bonita 7.13, ProfileEntry is deprecated
*
* @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 s can search on attributes (optional)
* @return List<ProfileEntry>
* @deprecated
*/
@Deprecated
@RequestLine("GET /API/portal/profileEntry?p={p}&c={c}&f={f}&s={s}")
@Headers({
"Accept: application/json",
})
List searchProfileEntries(@Param("p") Integer p, @Param("c") Integer c, @Param("f") List f,
@Param("s") String s);
/**
* Finds ProfileEntries
* Similar to searchProfileEntries but it also returns the http response headers .
* Finds ProfileEntries with pagination params and filters - can search on `name` - can filter on `page`,`name` and
* `parent_id` Warning: Since Bonita 7.13, ProfileEntry is deprecated
*
* @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 s can search on attributes (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
* @deprecated
*/
@Deprecated
@RequestLine("GET /API/portal/profileEntry?p={p}&c={c}&f={f}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchProfileEntriesWithHttpInfo(@Param("p") Integer p, @Param("c") Integer c,
@Param("f") List f, @Param("s") String s);
/**
* Finds ProfileEntries
* Finds ProfileEntries with pagination params and filters - can search on `name` - can filter on `page`,`name` and
* `parent_id` Warning: Since Bonita 7.13, ProfileEntry is deprecated
* Note, this is equivalent to the other searchProfileEntries 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 SearchProfileEntriesQueryParams} 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)
* - s - can search on attributes (optional)
*
* @return List<ProfileEntry>
* @deprecated
*/
@Deprecated
@RequestLine("GET /API/portal/profileEntry?p={p}&c={c}&f={f}&s={s}")
@Headers({
"Accept: application/json",
})
List searchProfileEntries(@QueryMap(encoded = true) SearchProfileEntriesQueryParams queryParams);
/**
* Finds ProfileEntries
* Finds ProfileEntries with pagination params and filters - can search on `name` - can filter on `page`,`name` and
* `parent_id` Warning: Since Bonita 7.13, ProfileEntry is deprecated
* Note, this is equivalent to the other searchProfileEntries 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)
* - s - can search on attributes (optional)
*
* @return List<ProfileEntry>
* @deprecated
*/
@Deprecated
@RequestLine("GET /API/portal/profileEntry?p={p}&c={c}&f={f}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchProfileEntriesWithHttpInfo(
@QueryMap(encoded = true) SearchProfileEntriesQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* searchProfileEntries method in a fluent style.
*/
public static class SearchProfileEntriesQueryParams extends HashMap {
public SearchProfileEntriesQueryParams p(final Integer value) {
put("p", EncodingUtils.encode(value));
return this;
}
public SearchProfileEntriesQueryParams c(final Integer value) {
put("c", EncodingUtils.encode(value));
return this;
}
public SearchProfileEntriesQueryParams f(final List value) {
put("f", EncodingUtils.encodeCollection(value, "multi"));
return this;
}
public SearchProfileEntriesQueryParams s(final String value) {
put("s", EncodingUtils.encode(value));
return this;
}
}
/**
* Update the ProfileEntry by ID
* Update the ProfileEntry for the given ID Warning: Since Bonita 7.13, ProfileEntry is deprecated
*
* @param id ID of the ProfileEntry to return (required)
* @param profileEntryUpdateRequest Partial ProfileEntry description (required)
* @deprecated
*/
@Deprecated
@RequestLine("PUT /API/portal/profileEntry/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void updateProfileEntryById(@Param("id") String id, ProfileEntryUpdateRequest profileEntryUpdateRequest);
/**
* Update the ProfileEntry by ID
* Similar to updateProfileEntryById but it also returns the http response headers .
* Update the ProfileEntry for the given ID Warning: Since Bonita 7.13, ProfileEntry is deprecated
*
* @param id ID of the ProfileEntry to return (required)
* @param profileEntryUpdateRequest Partial ProfileEntry description (required)
* @deprecated
*/
@Deprecated
@RequestLine("PUT /API/portal/profileEntry/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse updateProfileEntryByIdWithHttpInfo(@Param("id") String id,
ProfileEntryUpdateRequest profileEntryUpdateRequest);
}