org.bonitasoft.web.client.api.HumanTaskApi 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 getHumanTaskById but it also returns the http response headers .
* Returns the single HumanTask for the given ID
*
* @param id ID of the HumanTask to return (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/bpm/humanTask/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getHumanTaskByIdWithHttpInfo(@Param("id") String id);
/**
* Finds HumanTasks
* Finds HumanTasks with pagination params and filters - can order on `name`, `priority`, `dueDate`, `state`,
* `processDefinitionId`, `processInstanceId`, `parentActivityInstanceId`, `assigneeId`, `parentContainerId`,
* `displayName`, `reachedStateDate` - can search on any field that can be used to order results - can filter on `assigned_id`,
* `user_id`, `show_assigned_to_others` (since 2022.2), `state`, `name`, `displayName`,
* `processDefinitionId`, `caseId`, `rootProcessInstanceId`, `parentProcessInstanceId`
*
* @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<HumanTask>
*/
@RequestLine("GET /API/bpm/humanTask?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
List searchHumanTasks(@Param("p") Integer p, @Param("c") Integer c, @Param("f") List f,
@Param("o") String o, @Param("s") String s);
/**
* Finds HumanTasks
* Similar to searchHumanTasks but it also returns the http response headers .
* Finds HumanTasks with pagination params and filters - can order on `name`, `priority`, `dueDate`, `state`,
* `processDefinitionId`, `processInstanceId`, `parentActivityInstanceId`, `assigneeId`, `parentContainerId`,
* `displayName`, `reachedStateDate` - can search on any field that can be used to order results - can filter on `assigned_id`,
* `user_id`, `show_assigned_to_others` (since 2022.2), `state`, `name`, `displayName`,
* `processDefinitionId`, `caseId`, `rootProcessInstanceId`, `parentProcessInstanceId`
*
* @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/humanTask?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchHumanTasksWithHttpInfo(@Param("p") Integer p, @Param("c") Integer c,
@Param("f") List f, @Param("o") String o, @Param("s") String s);
/**
* Finds HumanTasks
* Finds HumanTasks with pagination params and filters - can order on `name`, `priority`, `dueDate`, `state`,
* `processDefinitionId`, `processInstanceId`, `parentActivityInstanceId`, `assigneeId`, `parentContainerId`,
* `displayName`, `reachedStateDate` - can search on any field that can be used to order results - can filter on `assigned_id`,
* `user_id`, `show_assigned_to_others` (since 2022.2), `state`, `name`, `displayName`,
* `processDefinitionId`, `caseId`, `rootProcessInstanceId`, `parentProcessInstanceId`
* Note, this is equivalent to the other searchHumanTasks 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 SearchHumanTasksQueryParams} 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<HumanTask>
*/
@RequestLine("GET /API/bpm/humanTask?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
List searchHumanTasks(@QueryMap(encoded = true) SearchHumanTasksQueryParams queryParams);
/**
* Finds HumanTasks
* Finds HumanTasks with pagination params and filters - can order on `name`, `priority`, `dueDate`, `state`,
* `processDefinitionId`, `processInstanceId`, `parentActivityInstanceId`, `assigneeId`, `parentContainerId`,
* `displayName`, `reachedStateDate` - can search on any field that can be used to order results - can filter on `assigned_id`,
* `user_id`, `show_assigned_to_others` (since 2022.2), `state`, `name`, `displayName`,
* `processDefinitionId`, `caseId`, `rootProcessInstanceId`, `parentProcessInstanceId`
* Note, this is equivalent to the other searchHumanTasks 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<HumanTask>
*/
@RequestLine("GET /API/bpm/humanTask?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchHumanTasksWithHttpInfo(
@QueryMap(encoded = true) SearchHumanTasksQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* searchHumanTasks method in a fluent style.
*/
public static class SearchHumanTasksQueryParams extends HashMap {
public SearchHumanTasksQueryParams p(final Integer value) {
put("p", EncodingUtils.encode(value));
return this;
}
public SearchHumanTasksQueryParams c(final Integer value) {
put("c", EncodingUtils.encode(value));
return this;
}
public SearchHumanTasksQueryParams f(final List value) {
put("f", EncodingUtils.encodeCollection(value, "multi"));
return this;
}
public SearchHumanTasksQueryParams o(final String value) {
put("o", EncodingUtils.encode(value));
return this;
}
public SearchHumanTasksQueryParams s(final String value) {
put("s", EncodingUtils.encode(value));
return this;
}
}
/**
* Update the HumanTask by ID
* Update the HumanTask for the given ID
*
* @param id ID of the HumanTask to return (required)
* @param humanTaskUpdateRequest Fields that can be updated are `assignedId` and `state`. Specify only those fields that you want to change.
* (required)
*/
@RequestLine("PUT /API/bpm/humanTask/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void updateHumanTaskById(@Param("id") String id, HumanTaskUpdateRequest humanTaskUpdateRequest);
/**
* Update the HumanTask by ID
* Similar to updateHumanTaskById but it also returns the http response headers .
* Update the HumanTask for the given ID
*
* @param id ID of the HumanTask to return (required)
* @param humanTaskUpdateRequest Fields that can be updated are `assignedId` and `state`. Specify only those fields that you want to change.
* (required)
*/
@RequestLine("PUT /API/bpm/humanTask/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse updateHumanTaskByIdWithHttpInfo(@Param("id") String id,
HumanTaskUpdateRequest humanTaskUpdateRequest);
}