org.bonitasoft.web.client.api.ProcessSupervisorApi 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 createProcessSupervisor but it also returns the http response headers .
* Create the ProcessSupervisor
*
* @param body The process definition id and either the user, role and/or group id. (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /API/bpm/processSupervisor")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createProcessSupervisorWithHttpInfo(ProcessSupervisor body);
/**
* Delete the ProcessSupervisor by ID
* Delete the ProcessSupervisor for the given compoound IDs You can delete a process supervisor by specifying its compound Id in the body of the request with
* the following format: `process_id/user_id/role_id/group_id`
*
* @param requestBody The process definition id and either the user, role and/or group id. (required)
*/
@RequestLine("DELETE /API/bpm/processSupervisor")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void deleteProcessSupervisorById(List requestBody);
/**
* Delete the ProcessSupervisor by ID
* Similar to deleteProcessSupervisorById but it also returns the http response headers .
* Delete the ProcessSupervisor for the given compoound IDs You can delete a process supervisor by specifying its compound Id in the body of the request with
* the following format: `process_id/user_id/role_id/group_id`
*
* @param requestBody The process definition id and either the user, role and/or group id. (required)
*/
@RequestLine("DELETE /API/bpm/processSupervisor")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse deleteProcessSupervisorByIdWithHttpInfo(List requestBody);
/**
* Finds ProcessSupervisors
* Finds ProcessSupervisors with pagination params and filters To filter, you need to specify the `process_id`, and then the `user_id`,
* `group_id` and `role_id` with one of them (two if you want to filter on group and role) set to `>0` and the other ones set
* to `-1`. E.g.: `f=process_id%3D8040901857674754544&f=user_id%3D>0&f=group_id%3D-1&f=role_id%3D-1`
*
* @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<ProcessSupervisor>
*/
@RequestLine("GET /API/bpm/processSupervisor?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
List searchProcessSupervisors(@Param("p") Integer p, @Param("c") Integer c,
@Param("f") List f, @Param("o") String o, @Param("s") String s);
/**
* Finds ProcessSupervisors
* Similar to searchProcessSupervisors but it also returns the http response headers .
* Finds ProcessSupervisors with pagination params and filters To filter, you need to specify the `process_id`, and then the `user_id`,
* `group_id` and `role_id` with one of them (two if you want to filter on group and role) set to `>0` and the other ones set
* to `-1`. E.g.: `f=process_id%3D8040901857674754544&f=user_id%3D>0&f=group_id%3D-1&f=role_id%3D-1`
*
* @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/bpm/processSupervisor?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchProcessSupervisorsWithHttpInfo(@Param("p") Integer p,
@Param("c") Integer c, @Param("f") List f, @Param("o") String o, @Param("s") String s);
/**
* Finds ProcessSupervisors
* Finds ProcessSupervisors with pagination params and filters To filter, you need to specify the `process_id`, and then the `user_id`,
* `group_id` and `role_id` with one of them (two if you want to filter on group and role) set to `>0` and the other ones set
* to `-1`. E.g.: `f=process_id%3D8040901857674754544&f=user_id%3D>0&f=group_id%3D-1&f=role_id%3D-1`
* Note, this is equivalent to the other searchProcessSupervisors 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 SearchProcessSupervisorsQueryParams} 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<ProcessSupervisor>
*/
@RequestLine("GET /API/bpm/processSupervisor?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
List searchProcessSupervisors(
@QueryMap(encoded = true) SearchProcessSupervisorsQueryParams queryParams);
/**
* Finds ProcessSupervisors
* Finds ProcessSupervisors with pagination params and filters To filter, you need to specify the `process_id`, and then the `user_id`,
* `group_id` and `role_id` with one of them (two if you want to filter on group and role) set to `>0` and the other ones set
* to `-1`. E.g.: `f=process_id%3D8040901857674754544&f=user_id%3D>0&f=group_id%3D-1&f=role_id%3D-1`
* Note, this is equivalent to the other searchProcessSupervisors 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<ProcessSupervisor>
*/
@RequestLine("GET /API/bpm/processSupervisor?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchProcessSupervisorsWithHttpInfo(
@QueryMap(encoded = true) SearchProcessSupervisorsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* searchProcessSupervisors method in a fluent style.
*/
public static class SearchProcessSupervisorsQueryParams extends HashMap {
public SearchProcessSupervisorsQueryParams p(final Integer value) {
put("p", EncodingUtils.encode(value));
return this;
}
public SearchProcessSupervisorsQueryParams c(final Integer value) {
put("c", EncodingUtils.encode(value));
return this;
}
public SearchProcessSupervisorsQueryParams f(final List value) {
put("f", EncodingUtils.encodeCollection(value, "multi"));
return this;
}
public SearchProcessSupervisorsQueryParams o(final String value) {
put("o", EncodingUtils.encode(value));
return this;
}
public SearchProcessSupervisorsQueryParams s(final String value) {
put("s", EncodingUtils.encode(value));
return this;
}
}
}