org.bonitasoft.web.client.api.ActivityApi 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 getActivityById but it also returns the http response headers .
* Returns the single Activity for the given ID
*
* @param id ID of the Activity to return (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/bpm/activity/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getActivityByIdWithHttpInfo(@Param("id") String id);
/**
* Finds Activities
* Finds Activities with pagination params and filters. Activities in states completed, cancelled, or aborted are not retrieved. The search returns an array of
* activities. - can order on `name`, `displayName`, `state`, `processDefinitionId`,
* `parentProcessInstanceId`, `parentActivityInstanceId` (order by parent activity id), `rootProcessInstanceId`,
* `lastUpdateDate` - can search on `name`, `displayName`, `state`, `processDefinitionId`,
* `parentProcessInstanceId`, `parentActivityInstanceId` (order by parent activity id), `rootProcessInstanceId`,
* `lastUpdateDate` - can filter on `name`, `state`, `processId`, `parentProcessInstanceId`,
* `rootProcessInstanceId`, `last_update_date`, `supervisor_id` (only in Enterprise editions)
*
* @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<Activity>
*/
@RequestLine("GET /API/bpm/activity?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
List searchActivities(@Param("p") Integer p, @Param("c") Integer c, @Param("f") List f,
@Param("o") String o, @Param("s") String s);
/**
* Finds Activities
* Similar to searchActivities but it also returns the http response headers .
* Finds Activities with pagination params and filters. Activities in states completed, cancelled, or aborted are not retrieved. The search returns an array of
* activities. - can order on `name`, `displayName`, `state`, `processDefinitionId`,
* `parentProcessInstanceId`, `parentActivityInstanceId` (order by parent activity id), `rootProcessInstanceId`,
* `lastUpdateDate` - can search on `name`, `displayName`, `state`, `processDefinitionId`,
* `parentProcessInstanceId`, `parentActivityInstanceId` (order by parent activity id), `rootProcessInstanceId`,
* `lastUpdateDate` - can filter on `name`, `state`, `processId`, `parentProcessInstanceId`,
* `rootProcessInstanceId`, `last_update_date`, `supervisor_id` (only in Enterprise editions)
*
* @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/activity?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchActivitiesWithHttpInfo(@Param("p") Integer p, @Param("c") Integer c,
@Param("f") List f, @Param("o") String o, @Param("s") String s);
/**
* Finds Activities
* Finds Activities with pagination params and filters. Activities in states completed, cancelled, or aborted are not retrieved. The search returns an array of
* activities. - can order on `name`, `displayName`, `state`, `processDefinitionId`,
* `parentProcessInstanceId`, `parentActivityInstanceId` (order by parent activity id), `rootProcessInstanceId`,
* `lastUpdateDate` - can search on `name`, `displayName`, `state`, `processDefinitionId`,
* `parentProcessInstanceId`, `parentActivityInstanceId` (order by parent activity id), `rootProcessInstanceId`,
* `lastUpdateDate` - can filter on `name`, `state`, `processId`, `parentProcessInstanceId`,
* `rootProcessInstanceId`, `last_update_date`, `supervisor_id` (only in Enterprise editions)
* Note, this is equivalent to the other searchActivities 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 SearchActivitiesQueryParams} 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<Activity>
*/
@RequestLine("GET /API/bpm/activity?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
List searchActivities(@QueryMap(encoded = true) SearchActivitiesQueryParams queryParams);
/**
* Finds Activities
* Finds Activities with pagination params and filters. Activities in states completed, cancelled, or aborted are not retrieved. The search returns an array of
* activities. - can order on `name`, `displayName`, `state`, `processDefinitionId`,
* `parentProcessInstanceId`, `parentActivityInstanceId` (order by parent activity id), `rootProcessInstanceId`,
* `lastUpdateDate` - can search on `name`, `displayName`, `state`, `processDefinitionId`,
* `parentProcessInstanceId`, `parentActivityInstanceId` (order by parent activity id), `rootProcessInstanceId`,
* `lastUpdateDate` - can filter on `name`, `state`, `processId`, `parentProcessInstanceId`,
* `rootProcessInstanceId`, `last_update_date`, `supervisor_id` (only in Enterprise editions)
* Note, this is equivalent to the other searchActivities 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<Activity>
*/
@RequestLine("GET /API/bpm/activity?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchActivitiesWithHttpInfo(
@QueryMap(encoded = true) SearchActivitiesQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* searchActivities method in a fluent style.
*/
public static class SearchActivitiesQueryParams extends HashMap {
public SearchActivitiesQueryParams p(final Integer value) {
put("p", EncodingUtils.encode(value));
return this;
}
public SearchActivitiesQueryParams c(final Integer value) {
put("c", EncodingUtils.encode(value));
return this;
}
public SearchActivitiesQueryParams f(final List value) {
put("f", EncodingUtils.encodeCollection(value, "multi"));
return this;
}
public SearchActivitiesQueryParams o(final String value) {
put("o", EncodingUtils.encode(value));
return this;
}
public SearchActivitiesQueryParams s(final String value) {
put("s", EncodingUtils.encode(value));
return this;
}
}
/**
* Update the Activity by ID
* Update the Activity for the given ID
*
* @param id ID of the Activity to return (required)
* @param activityUpdateRequest Partial Activity description (required)
*/
@RequestLine("PUT /API/bpm/activity/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void updateActivityById(@Param("id") String id, ActivityUpdateRequest activityUpdateRequest);
/**
* Update the Activity by ID
* Similar to updateActivityById but it also returns the http response headers .
* Update the Activity for the given ID
*
* @param id ID of the Activity to return (required)
* @param activityUpdateRequest Partial Activity description (required)
*/
@RequestLine("PUT /API/bpm/activity/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse updateActivityByIdWithHttpInfo(@Param("id") String id,
ActivityUpdateRequest activityUpdateRequest);
}