org.bonitasoft.web.client.api.ArchivedProcessInstanceVariableApi 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 getArchivedProcessInstanceVariables(@Param("p") Integer p,
@Param("c") Integer c, @Param("f") String f);
/**
* Finds ArchivedProcessInstance Variables
* Similar to getArchivedProcessInstanceVariables but it also returns the http response headers .
* Since 2022.1 Finds ArchivedProcessInstance Variables with pagination params and filters
*
* @param p index of the page to display (required)
* @param c maximum number of elements to retrieve (required)
* @param f Filter for the case id before it was archived (eg: case_id=10001 ) (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/bpm/archivedCaseVariable?p={p}&c={c}&f={f}")
@Headers({
"Accept: application/json",
})
ApiResponse> getArchivedProcessInstanceVariablesWithHttpInfo(
@Param("p") Integer p, @Param("c") Integer c, @Param("f") String f);
/**
* Finds ArchivedProcessInstance Variables
* Since 2022.1 Finds ArchivedProcessInstance Variables with pagination params and filters
* Note, this is equivalent to the other getArchivedProcessInstanceVariables 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 GetArchivedProcessInstanceVariablesQueryParams} 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 - Filter for the case id before it was archived (eg: case_id=10001 ) (required)
*
* @return List<ArchivedProcessInstanceVariable>
*/
@RequestLine("GET /API/bpm/archivedCaseVariable?p={p}&c={c}&f={f}")
@Headers({
"Accept: application/json",
})
List getArchivedProcessInstanceVariables(
@QueryMap(encoded = true) GetArchivedProcessInstanceVariablesQueryParams queryParams);
/**
* Finds ArchivedProcessInstance Variables
* Since 2022.1 Finds ArchivedProcessInstance Variables with pagination params and filters
* Note, this is equivalent to the other getArchivedProcessInstanceVariables 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 - Filter for the case id before it was archived (eg: case_id=10001 ) (required)
*
* @return List<ArchivedProcessInstanceVariable>
*/
@RequestLine("GET /API/bpm/archivedCaseVariable?p={p}&c={c}&f={f}")
@Headers({
"Accept: application/json",
})
ApiResponse> getArchivedProcessInstanceVariablesWithHttpInfo(
@QueryMap(encoded = true) GetArchivedProcessInstanceVariablesQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getArchivedProcessInstanceVariables method in a fluent style.
*/
public static class GetArchivedProcessInstanceVariablesQueryParams extends HashMap {
public GetArchivedProcessInstanceVariablesQueryParams p(final Integer value) {
put("p", EncodingUtils.encode(value));
return this;
}
public GetArchivedProcessInstanceVariablesQueryParams c(final Integer value) {
put("c", EncodingUtils.encode(value));
return this;
}
public GetArchivedProcessInstanceVariablesQueryParams f(final String value) {
put("f", EncodingUtils.encode(value));
return this;
}
}
/**
* Finds an archived Variable by ProcessInstance ID and variable name
* Since 2022.1 Returns the single ArchivedProcessInstanceVariable for the given ProcessInstance ID and variable name
*
* @param id The identifier of the process instance from which to retrieve the archived variable (required)
* @param variableName The name of the archived variable to retrieve (required)
* @return ArchivedProcessInstanceVariable
*/
@RequestLine("GET /API/bpm/archivedCaseVariable/{id}/{variableName}")
@Headers({
"Accept: application/json",
})
ArchivedProcessInstanceVariable getArchivedVariableByProcessInstance(@Param("id") String id,
@Param("variableName") String variableName);
/**
* Finds an archived Variable by ProcessInstance ID and variable name
* Similar to getArchivedVariableByProcessInstance but it also returns the http response headers .
* Since 2022.1 Returns the single ArchivedProcessInstanceVariable for the given ProcessInstance ID and variable name
*
* @param id The identifier of the process instance from which to retrieve the archived variable (required)
* @param variableName The name of the archived variable to retrieve (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/bpm/archivedCaseVariable/{id}/{variableName}")
@Headers({
"Accept: application/json",
})
ApiResponse getArchivedVariableByProcessInstanceWithHttpInfo(
@Param("id") String id, @Param("variableName") String variableName);
}