org.bonitasoft.web.client.api.ArchivedManualTaskApi 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 getArchivedManualTaskById but it also returns the http response headers .
* Returns the single ArchivedManualTask for the given ID
*
* @param id ID of the ArchivedManualTask to return (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/bpm/archivedManualTask/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getArchivedManualTaskByIdWithHttpInfo(@Param("id") String id);
/**
* Finds ArchivedManualTasks
* Finds ArchivedManualTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the human tasks
* assigned to the specified ID. For example, retrieve the human tasks assigned to user with id 2:
* `/API/bpm/archivedHumanTask?p=0&c=10&f=assigned_id%3d2` * `state=`: retrieve only the archived user tasks
* with the specified state. For example, retrieve the skipped tasks:
* `/API/bpm/archivedHumanTask?p=0&c=10&f=state=skipped` * `name=`: retrieve only the human tasks with the
* specified name. For example, retrieve the human tasks with the name \"Analyse ProcessInstance\":
* `/API/bpm/archivedHumanTask?p=0&c=10&f=name=Analyse ProcessInstance` * `displayName=`: retrieve only the
* archived user tasks with the specified displayName. For example, retrieve the human tasks with the displayName \"Analyse ProcessInstance\":
* `/API/bpm/archivedHumanTask?p=0&c=10&f=displayName=Analyse ProcessInstance`
*
* @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)
* @return List<ArchivedManualTask>
*/
@RequestLine("GET /API/bpm/archivedManualTask?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
List searchArchivedManualTasks(@Param("p") Integer p, @Param("c") Integer c,
@Param("f") List f, @Param("o") String o);
/**
* Finds ArchivedManualTasks
* Similar to searchArchivedManualTasks but it also returns the http response headers .
* Finds ArchivedManualTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the human tasks
* assigned to the specified ID. For example, retrieve the human tasks assigned to user with id 2:
* `/API/bpm/archivedHumanTask?p=0&c=10&f=assigned_id%3d2` * `state=`: retrieve only the archived user tasks
* with the specified state. For example, retrieve the skipped tasks:
* `/API/bpm/archivedHumanTask?p=0&c=10&f=state=skipped` * `name=`: retrieve only the human tasks with the
* specified name. For example, retrieve the human tasks with the name \"Analyse ProcessInstance\":
* `/API/bpm/archivedHumanTask?p=0&c=10&f=name=Analyse ProcessInstance` * `displayName=`: retrieve only the
* archived user tasks with the specified displayName. For example, retrieve the human tasks with the displayName \"Analyse ProcessInstance\":
* `/API/bpm/archivedHumanTask?p=0&c=10&f=displayName=Analyse ProcessInstance`
*
* @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)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/bpm/archivedManualTask?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchArchivedManualTasksWithHttpInfo(@Param("p") Integer p,
@Param("c") Integer c, @Param("f") List f, @Param("o") String o);
/**
* Finds ArchivedManualTasks
* Finds ArchivedManualTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the human tasks
* assigned to the specified ID. For example, retrieve the human tasks assigned to user with id 2:
* `/API/bpm/archivedHumanTask?p=0&c=10&f=assigned_id%3d2` * `state=`: retrieve only the archived user tasks
* with the specified state. For example, retrieve the skipped tasks:
* `/API/bpm/archivedHumanTask?p=0&c=10&f=state=skipped` * `name=`: retrieve only the human tasks with the
* specified name. For example, retrieve the human tasks with the name \"Analyse ProcessInstance\":
* `/API/bpm/archivedHumanTask?p=0&c=10&f=name=Analyse ProcessInstance` * `displayName=`: retrieve only the
* archived user tasks with the specified displayName. For example, retrieve the human tasks with the displayName \"Analyse ProcessInstance\":
* `/API/bpm/archivedHumanTask?p=0&c=10&f=displayName=Analyse ProcessInstance`
* Note, this is equivalent to the other searchArchivedManualTasks 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 SearchArchivedManualTasksQueryParams} 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)
*
* @return List<ArchivedManualTask>
*/
@RequestLine("GET /API/bpm/archivedManualTask?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
List searchArchivedManualTasks(
@QueryMap(encoded = true) SearchArchivedManualTasksQueryParams queryParams);
/**
* Finds ArchivedManualTasks
* Finds ArchivedManualTasks with pagination params and filters You can filter on: * `assigned_id={user_id}`: retrieve only the human tasks
* assigned to the specified ID. For example, retrieve the human tasks assigned to user with id 2:
* `/API/bpm/archivedHumanTask?p=0&c=10&f=assigned_id%3d2` * `state=`: retrieve only the archived user tasks
* with the specified state. For example, retrieve the skipped tasks:
* `/API/bpm/archivedHumanTask?p=0&c=10&f=state=skipped` * `name=`: retrieve only the human tasks with the
* specified name. For example, retrieve the human tasks with the name \"Analyse ProcessInstance\":
* `/API/bpm/archivedHumanTask?p=0&c=10&f=name=Analyse ProcessInstance` * `displayName=`: retrieve only the
* archived user tasks with the specified displayName. For example, retrieve the human tasks with the displayName \"Analyse ProcessInstance\":
* `/API/bpm/archivedHumanTask?p=0&c=10&f=displayName=Analyse ProcessInstance`
* Note, this is equivalent to the other searchArchivedManualTasks 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)
*
* @return List<ArchivedManualTask>
*/
@RequestLine("GET /API/bpm/archivedManualTask?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchArchivedManualTasksWithHttpInfo(
@QueryMap(encoded = true) SearchArchivedManualTasksQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* searchArchivedManualTasks method in a fluent style.
*/
public static class SearchArchivedManualTasksQueryParams extends HashMap {
public SearchArchivedManualTasksQueryParams p(final Integer value) {
put("p", EncodingUtils.encode(value));
return this;
}
public SearchArchivedManualTasksQueryParams c(final Integer value) {
put("c", EncodingUtils.encode(value));
return this;
}
public SearchArchivedManualTasksQueryParams f(final List value) {
put("f", EncodingUtils.encodeCollection(value, "multi"));
return this;
}
public SearchArchivedManualTasksQueryParams o(final String value) {
put("o", EncodingUtils.encode(value));
return this;
}
}
}