org.bonitasoft.web.client.api.ArchivedProcessInstanceApi 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 deleteArchivedProcessInstanceById but it also returns the http response headers .
* Delete the single ArchivedProcessInstance for the given ID
*
* @param id ID of the ArchivedProcessInstance to delete (required)
*/
@RequestLine("DELETE /API/bpm/archivedCase/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteArchivedProcessInstanceByIdWithHttpInfo(@Param("id") String id);
/**
* Finds the ArchivedProcessInstance by ID
* Returns the single ArchivedProcessInstance for the given ID
*
* @param id ID of the ArchivedProcessInstance to return (required)
* @return ArchivedProcessInstance
*/
@RequestLine("GET /API/bpm/archivedCase/{id}")
@Headers({
"Accept: application/json",
})
ArchivedProcessInstance getArchivedProcessInstanceById(@Param("id") String id);
/**
* Finds the ArchivedProcessInstance by ID
* Similar to getArchivedProcessInstanceById but it also returns the http response headers .
* Returns the single ArchivedProcessInstance for the given ID
*
* @param id ID of the ArchivedProcessInstance to return (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/bpm/archivedCase/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getArchivedProcessInstanceByIdWithHttpInfo(@Param("id") String id);
/**
* Finds the Context by ArchivedProcessInstance ID
* Returns the Context for the given ArchivedProcessInstance ID
*
* @param id ID of the ArchivedProcessInstance that has the Context to return (required)
* @return Map<String, Object>
*/
@RequestLine("GET /API/bpm/archivedCase/{id}/context")
@Headers({
"Accept: application/json",
})
Map getContextByArchivedProcessInstanceId(@Param("id") String id);
/**
* Finds the Context by ArchivedProcessInstance ID
* Similar to getContextByArchivedProcessInstanceId but it also returns the http response headers .
* Returns the Context for the given ArchivedProcessInstance ID
*
* @param id ID of the ArchivedProcessInstance that has the Context to return (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/bpm/archivedCase/{id}/context")
@Headers({
"Accept: application/json",
})
ApiResponse> getContextByArchivedProcessInstanceIdWithHttpInfo(@Param("id") String id);
/**
* Finds ArchivedProcessInstances
* Finds archived ProcessInstances (or ProcessInstance) with pagination params and filters You can order on `id`, `processDefinitionId`,
* `startedBy`, `startedBySubstitute`, `startDate`, `endDate`, `lastUpdate`, `archivedDate`,
* `sourceObjectId` You can filter on : * `sourceObjectId`: The original process instance ID before the process instance was archived *
* `processDefinitionId`: The process derfinition ID * `name`: the process name * `started_by`: the ID of the user who started the
* process * `team_manager_id`: allow to retrieve the process instances in which all users with this manager ID ar involved) *
* `supervisor_id`: allow the retrived the process instances of all processes the user with this ID is supervisor of) beware you cannot use
* team_manager_id and supervisor_id at the same time
*
* @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<ArchivedProcessInstance>
*/
@RequestLine("GET /API/bpm/archivedCase?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
List searchArchivedProcessInstances(@Param("p") Integer p, @Param("c") Integer c,
@Param("f") List f, @Param("o") String o);
/**
* Finds ArchivedProcessInstances
* Similar to searchArchivedProcessInstances but it also returns the http response headers .
* Finds archived ProcessInstances (or ProcessInstance) with pagination params and filters You can order on `id`, `processDefinitionId`,
* `startedBy`, `startedBySubstitute`, `startDate`, `endDate`, `lastUpdate`, `archivedDate`,
* `sourceObjectId` You can filter on : * `sourceObjectId`: The original process instance ID before the process instance was archived *
* `processDefinitionId`: The process derfinition ID * `name`: the process name * `started_by`: the ID of the user who started the
* process * `team_manager_id`: allow to retrieve the process instances in which all users with this manager ID ar involved) *
* `supervisor_id`: allow the retrived the process instances of all processes the user with this ID is supervisor of) beware you cannot use
* team_manager_id and supervisor_id at the same time
*
* @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/archivedCase?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchArchivedProcessInstancesWithHttpInfo(@Param("p") Integer p,
@Param("c") Integer c, @Param("f") List f, @Param("o") String o);
/**
* Finds ArchivedProcessInstances
* Finds archived ProcessInstances (or ProcessInstance) with pagination params and filters You can order on `id`, `processDefinitionId`,
* `startedBy`, `startedBySubstitute`, `startDate`, `endDate`, `lastUpdate`, `archivedDate`,
* `sourceObjectId` You can filter on : * `sourceObjectId`: The original process instance ID before the process instance was archived *
* `processDefinitionId`: The process derfinition ID * `name`: the process name * `started_by`: the ID of the user who started the
* process * `team_manager_id`: allow to retrieve the process instances in which all users with this manager ID ar involved) *
* `supervisor_id`: allow the retrived the process instances of all processes the user with this ID is supervisor of) beware you cannot use
* team_manager_id and supervisor_id at the same time
* Note, this is equivalent to the other searchArchivedProcessInstances 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 SearchArchivedProcessInstancesQueryParams} 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<ArchivedProcessInstance>
*/
@RequestLine("GET /API/bpm/archivedCase?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
List searchArchivedProcessInstances(
@QueryMap(encoded = true) SearchArchivedProcessInstancesQueryParams queryParams);
/**
* Finds ArchivedProcessInstances
* Finds archived ProcessInstances (or ProcessInstance) with pagination params and filters You can order on `id`, `processDefinitionId`,
* `startedBy`, `startedBySubstitute`, `startDate`, `endDate`, `lastUpdate`, `archivedDate`,
* `sourceObjectId` You can filter on : * `sourceObjectId`: The original process instance ID before the process instance was archived *
* `processDefinitionId`: The process derfinition ID * `name`: the process name * `started_by`: the ID of the user who started the
* process * `team_manager_id`: allow to retrieve the process instances in which all users with this manager ID ar involved) *
* `supervisor_id`: allow the retrived the process instances of all processes the user with this ID is supervisor of) beware you cannot use
* team_manager_id and supervisor_id at the same time
* Note, this is equivalent to the other searchArchivedProcessInstances 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<ArchivedProcessInstance>
*/
@RequestLine("GET /API/bpm/archivedCase?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchArchivedProcessInstancesWithHttpInfo(
@QueryMap(encoded = true) SearchArchivedProcessInstancesQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* searchArchivedProcessInstances method in a fluent style.
*/
public static class SearchArchivedProcessInstancesQueryParams extends HashMap {
public SearchArchivedProcessInstancesQueryParams p(final Integer value) {
put("p", EncodingUtils.encode(value));
return this;
}
public SearchArchivedProcessInstancesQueryParams c(final Integer value) {
put("c", EncodingUtils.encode(value));
return this;
}
public SearchArchivedProcessInstancesQueryParams f(final List value) {
put("f", EncodingUtils.encodeCollection(value, "multi"));
return this;
}
public SearchArchivedProcessInstancesQueryParams o(final String value) {
put("o", EncodingUtils.encode(value));
return this;
}
}
}