org.bonitasoft.web.client.api.ProcessInstanceApi 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 createProcessInstance but it also returns the http response headers .
*   Create the
* ProcessInstance This way of creating a process instance using this method will only work for processes in which no contract is defined. To instantiate a
* process with a contract, check the process instantiation resource documentation.
*
* @param body **Warning**: The attribute `variables` on the request payload is used to initialize the process variables (not BDM variables). If you
* want to initialize BDM variables at process instantiation, add a contract on the process and map BDM variables to the contract data. See Start a
* process using an instantiation contract for usage. (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /API/bpm/case")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createProcessInstanceWithHttpInfo(ProcessInstanceCreateRequest body);
/**
* Delete the ProcessInstance by ID
* Delete the single ProcessInstance for the given ID
*
* @param id ID of the ProcessInstance to delete (required)
*/
@RequestLine("DELETE /API/bpm/case/{id}")
@Headers({
"Accept: application/json",
})
void deleteProcessInstanceById(@Param("id") String id);
/**
* Delete the ProcessInstance by ID
* Similar to deleteProcessInstanceById but it also returns the http response headers .
* Delete the single ProcessInstance for the given ID
*
* @param id ID of the ProcessInstance to delete (required)
*/
@RequestLine("DELETE /API/bpm/case/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteProcessInstanceByIdWithHttpInfo(@Param("id") String id);
/**
* Delete the ProcessInstance by batch
*   Delete a list of
* ProcessInstances for the given IDs
*
* @param requestBody (optional)
*/
@RequestLine("DELETE /API/bpm/case")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void deleteProcessInstanceByIds(List requestBody);
/**
* Delete the ProcessInstance by batch
* Similar to deleteProcessInstanceByIds but it also returns the http response headers .
*   Delete a list of
* ProcessInstances for the given IDs
*
* @param requestBody (optional)
*/
@RequestLine("DELETE /API/bpm/case")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse deleteProcessInstanceByIdsWithHttpInfo(List requestBody);
/**
* Finds the Context by ProcessInstance ID
* Returns the Context for the given ProcessInstance ID
*
* @param id ID of the ProcessInstance that has the Context to return (required)
* @return Map<String, Object>
*/
@RequestLine("GET /API/bpm/case/{id}/context")
@Headers({
"Accept: application/json",
})
Map getContextByProcessInstanceId(@Param("id") String id);
/**
* Finds the Context by ProcessInstance ID
* Similar to getContextByProcessInstanceId but it also returns the http response headers .
* Returns the Context for the given ProcessInstance ID
*
* @param id ID of the ProcessInstance that has the Context to return (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/bpm/case/{id}/context")
@Headers({
"Accept: application/json",
})
ApiResponse> getContextByProcessInstanceIdWithHttpInfo(@Param("id") String id);
/**
* Finds the ProcessInstance by ID
* Returns the single ProcessInstance for the given ID
*
* @param id ID of the ProcessInstance to return (required)
* @param n Count of related resources (optional)
* @return ProcessInstance
*/
@RequestLine("GET /API/bpm/case/{id}?n={n}")
@Headers({
"Accept: application/json",
})
ProcessInstance getProcessInstanceById(@Param("id") String id, @Param("n") String n);
/**
* Finds the ProcessInstance by ID
* Similar to getProcessInstanceById but it also returns the http response headers .
* Returns the single ProcessInstance for the given ID
*
* @param id ID of the ProcessInstance to return (required)
* @param n Count of related resources (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/bpm/case/{id}?n={n}")
@Headers({
"Accept: application/json",
})
ApiResponse getProcessInstanceByIdWithHttpInfo(@Param("id") String id, @Param("n") String n);
/**
* Finds the ProcessInstance by ID
* Returns the single ProcessInstance for the given ID
* Note, this is equivalent to the other getProcessInstanceById 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 GetProcessInstanceByIdQueryParams} class that allows for
* building up this map in a fluent style.
*
* @param id ID of the ProcessInstance to return (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - n - Count of related resources (optional)
*
* @return ProcessInstance
*/
@RequestLine("GET /API/bpm/case/{id}?n={n}")
@Headers({
"Accept: application/json",
})
ProcessInstance getProcessInstanceById(@Param("id") String id,
@QueryMap(encoded = true) GetProcessInstanceByIdQueryParams queryParams);
/**
* Finds the ProcessInstance by ID
* Returns the single ProcessInstance for the given ID
* Note, this is equivalent to the other getProcessInstanceById that receives the query parameters as a map,
* but this one also exposes the Http response headers
*
* @param id ID of the ProcessInstance to return (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - n - Count of related resources (optional)
*
* @return ProcessInstance
*/
@RequestLine("GET /API/bpm/case/{id}?n={n}")
@Headers({
"Accept: application/json",
})
ApiResponse getProcessInstanceByIdWithHttpInfo(@Param("id") String id,
@QueryMap(encoded = true) GetProcessInstanceByIdQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getProcessInstanceById method in a fluent style.
*/
public static class GetProcessInstanceByIdQueryParams extends HashMap {
public GetProcessInstanceByIdQueryParams n(final String value) {
put("n", EncodingUtils.encode(value));
return this;
}
}
/**
* Finds ProcessInstances
* Finds ProcessInstances with pagination params and filters You can filter on: * `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<ProcessInstance>
*/
@RequestLine("GET /API/bpm/case?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
List searchProcessInstances(@Param("p") Integer p, @Param("c") Integer c,
@Param("f") List f, @Param("o") String o);
/**
* Finds ProcessInstances
* Similar to searchProcessInstances but it also returns the http response headers .
* Finds ProcessInstances with pagination params and filters You can filter on: * `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/case?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchProcessInstancesWithHttpInfo(@Param("p") Integer p, @Param("c") Integer c,
@Param("f") List f, @Param("o") String o);
/**
* Finds ProcessInstances
* Finds ProcessInstances with pagination params and filters You can filter on: * `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 searchProcessInstances 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 SearchProcessInstancesQueryParams} 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<ProcessInstance>
*/
@RequestLine("GET /API/bpm/case?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
List searchProcessInstances(
@QueryMap(encoded = true) SearchProcessInstancesQueryParams queryParams);
/**
* Finds ProcessInstances
* Finds ProcessInstances with pagination params and filters You can filter on: * `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 searchProcessInstances 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<ProcessInstance>
*/
@RequestLine("GET /API/bpm/case?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchProcessInstancesWithHttpInfo(
@QueryMap(encoded = true) SearchProcessInstancesQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* searchProcessInstances method in a fluent style.
*/
public static class SearchProcessInstancesQueryParams extends HashMap {
public SearchProcessInstancesQueryParams p(final Integer value) {
put("p", EncodingUtils.encode(value));
return this;
}
public SearchProcessInstancesQueryParams c(final Integer value) {
put("c", EncodingUtils.encode(value));
return this;
}
public SearchProcessInstancesQueryParams f(final List value) {
put("f", EncodingUtils.encodeCollection(value, "multi"));
return this;
}
public SearchProcessInstancesQueryParams o(final String value) {
put("o", EncodingUtils.encode(value));
return this;
}
}
}