org.bonitasoft.web.client.api.FlowNodeApi 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 getFlowNodeById but it also returns the http response headers .
* Returns the single FlowNode for the given ID
*
* @param id ID of the FlowNode to return (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/bpm/flowNode/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getFlowNodeByIdWithHttpInfo(@Param("id") String id);
/**
* Finds FlowNodes
* Finds FlowNodes with pagination params and filters - can order on `name`, `displayName`, `state`,
* `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (if the retrieved flow nodes are activities, order
* by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can search on any field that can be used to order results - can
* filter on `name`, `state`, `processId`, `parentProcessInstanceId`, `rootProcessInstanceId`,
* `last_update_date`
*
* @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<FlowNode>
*/
@RequestLine("GET /API/bpm/flowNode?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
List searchFlowNodes(@Param("p") Integer p, @Param("c") Integer c, @Param("f") List f,
@Param("o") String o, @Param("s") String s);
/**
* Finds FlowNodes
* Similar to searchFlowNodes but it also returns the http response headers .
* Finds FlowNodes with pagination params and filters - can order on `name`, `displayName`, `state`,
* `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (if the retrieved flow nodes are activities, order
* by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can search on any field that can be used to order results - can
* filter on `name`, `state`, `processId`, `parentProcessInstanceId`, `rootProcessInstanceId`,
* `last_update_date`
*
* @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/flowNode?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchFlowNodesWithHttpInfo(@Param("p") Integer p, @Param("c") Integer c,
@Param("f") List f, @Param("o") String o, @Param("s") String s);
/**
* Finds FlowNodes
* Finds FlowNodes with pagination params and filters - can order on `name`, `displayName`, `state`,
* `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (if the retrieved flow nodes are activities, order
* by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can search on any field that can be used to order results - can
* filter on `name`, `state`, `processId`, `parentProcessInstanceId`, `rootProcessInstanceId`,
* `last_update_date`
* Note, this is equivalent to the other searchFlowNodes 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 SearchFlowNodesQueryParams} 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<FlowNode>
*/
@RequestLine("GET /API/bpm/flowNode?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
List searchFlowNodes(@QueryMap(encoded = true) SearchFlowNodesQueryParams queryParams);
/**
* Finds FlowNodes
* Finds FlowNodes with pagination params and filters - can order on `name`, `displayName`, `state`,
* `processDefinitionId`, `parentProcessInstanceId`, `parentActivityInstanceId` (if the retrieved flow nodes are activities, order
* by parent activity id), `rootProcessInstanceId`, `lastUpdateDate` - can search on any field that can be used to order results - can
* filter on `name`, `state`, `processId`, `parentProcessInstanceId`, `rootProcessInstanceId`,
* `last_update_date`
* Note, this is equivalent to the other searchFlowNodes 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<FlowNode>
*/
@RequestLine("GET /API/bpm/flowNode?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchFlowNodesWithHttpInfo(
@QueryMap(encoded = true) SearchFlowNodesQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* searchFlowNodes method in a fluent style.
*/
public static class SearchFlowNodesQueryParams extends HashMap {
public SearchFlowNodesQueryParams p(final Integer value) {
put("p", EncodingUtils.encode(value));
return this;
}
public SearchFlowNodesQueryParams c(final Integer value) {
put("c", EncodingUtils.encode(value));
return this;
}
public SearchFlowNodesQueryParams f(final List value) {
put("f", EncodingUtils.encodeCollection(value, "multi"));
return this;
}
public SearchFlowNodesQueryParams o(final String value) {
put("o", EncodingUtils.encode(value));
return this;
}
public SearchFlowNodesQueryParams s(final String value) {
put("s", EncodingUtils.encode(value));
return this;
}
}
/**
* Update the FlowNode by ID
*  Replay the flow node for the given ID.
*
* @param id ID of the FlowNode to return (required)
* @param flowNodeUpdateRequest Replay the flow node. (required)
*/
@RequestLine("PUT /API/bpm/flowNode/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void updateFlowNodeById(@Param("id") String id, FlowNodeUpdateRequest flowNodeUpdateRequest);
/**
* Update the FlowNode by ID
* Similar to updateFlowNodeById but it also returns the http response headers .
*  Replay the flow node for the given ID.
*
* @param id ID of the FlowNode to return (required)
* @param flowNodeUpdateRequest Replay the flow node. (required)
*/
@RequestLine("PUT /API/bpm/flowNode/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse updateFlowNodeByIdWithHttpInfo(@Param("id") String id,
FlowNodeUpdateRequest flowNodeUpdateRequest);
}