org.bonitasoft.web.client.api.ArchivedActivityApi 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 getArchivedActivityById but it also returns the http response headers .
* Returns the single Archived Activity for the given ID
*
* @param id ID of the Archived Activity to return (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/bpm/archivedActivity/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getArchivedActivityByIdWithHttpInfo(@Param("id") String id);
/**
* Finds Archived Activities
* Finds Archived 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` : the name of this activity - `displayName` : the display name of this activity -
* `state` : the current state of the activity - `type` : the activity type - `isTerminal` : say whether or not the activity is in
* a terminal state - `processId` : the process this activity is associated to - `caseId` : the process instance initiator this activity is
* associated to - `reached_state_date` : the date when this activity arrived in this state Can filter on: - `supervisor_id`: retrieve the
* information the process manager associated to this id has access to (only in Enterprise editions) - f: same as the sort order fields
*
* @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<ArchivedActivity>
*/
@RequestLine("GET /API/bpm/archivedActivity?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
List searchArchivedActivities(@Param("p") Integer p, @Param("c") Integer c,
@Param("f") List f, @Param("o") String o, @Param("s") String s);
/**
* Finds Archived Activities
* Similar to searchArchivedActivities but it also returns the http response headers .
* Finds Archived 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` : the name of this activity - `displayName` : the display name of this activity -
* `state` : the current state of the activity - `type` : the activity type - `isTerminal` : say whether or not the activity is in
* a terminal state - `processId` : the process this activity is associated to - `caseId` : the process instance initiator this activity is
* associated to - `reached_state_date` : the date when this activity arrived in this state Can filter on: - `supervisor_id`: retrieve the
* information the process manager associated to this id has access to (only in Enterprise editions) - f: same as the sort order fields
*
* @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/archivedActivity?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchArchivedActivitiesWithHttpInfo(@Param("p") Integer p,
@Param("c") Integer c, @Param("f") List f, @Param("o") String o, @Param("s") String s);
/**
* Finds Archived Activities
* Finds Archived 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` : the name of this activity - `displayName` : the display name of this activity -
* `state` : the current state of the activity - `type` : the activity type - `isTerminal` : say whether or not the activity is in
* a terminal state - `processId` : the process this activity is associated to - `caseId` : the process instance initiator this activity is
* associated to - `reached_state_date` : the date when this activity arrived in this state Can filter on: - `supervisor_id`: retrieve the
* information the process manager associated to this id has access to (only in Enterprise editions) - f: same as the sort order fields
* Note, this is equivalent to the other searchArchivedActivities 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 SearchArchivedActivitiesQueryParams} 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<ArchivedActivity>
*/
@RequestLine("GET /API/bpm/archivedActivity?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
List searchArchivedActivities(
@QueryMap(encoded = true) SearchArchivedActivitiesQueryParams queryParams);
/**
* Finds Archived Activities
* Finds Archived 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` : the name of this activity - `displayName` : the display name of this activity -
* `state` : the current state of the activity - `type` : the activity type - `isTerminal` : say whether or not the activity is in
* a terminal state - `processId` : the process this activity is associated to - `caseId` : the process instance initiator this activity is
* associated to - `reached_state_date` : the date when this activity arrived in this state Can filter on: - `supervisor_id`: retrieve the
* information the process manager associated to this id has access to (only in Enterprise editions) - f: same as the sort order fields
* Note, this is equivalent to the other searchArchivedActivities 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<ArchivedActivity>
*/
@RequestLine("GET /API/bpm/archivedActivity?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchArchivedActivitiesWithHttpInfo(
@QueryMap(encoded = true) SearchArchivedActivitiesQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* searchArchivedActivities method in a fluent style.
*/
public static class SearchArchivedActivitiesQueryParams extends HashMap {
public SearchArchivedActivitiesQueryParams p(final Integer value) {
put("p", EncodingUtils.encode(value));
return this;
}
public SearchArchivedActivitiesQueryParams c(final Integer value) {
put("c", EncodingUtils.encode(value));
return this;
}
public SearchArchivedActivitiesQueryParams f(final List value) {
put("f", EncodingUtils.encodeCollection(value, "multi"));
return this;
}
public SearchArchivedActivitiesQueryParams o(final String value) {
put("o", EncodingUtils.encode(value));
return this;
}
public SearchArchivedActivitiesQueryParams s(final String value) {
put("s", EncodingUtils.encode(value));
return this;
}
}
}