Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Camunda Platform REST API
* OpenApi Spec for Camunda Platform REST API.
*
* The version of the OpenAPI document: 7.21.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package org.camunda.community.rest.client.api;
import com.fasterxml.jackson.core.type.TypeReference;
import org.camunda.community.rest.client.invoker.ApiException;
import org.camunda.community.rest.client.invoker.ApiClient;
import org.camunda.community.rest.client.invoker.Configuration;
import org.camunda.community.rest.client.invoker.Pair;
import org.camunda.community.rest.client.dto.ActivityInstanceDto;
import org.camunda.community.rest.client.dto.AuthorizationExceptionDto;
import org.camunda.community.rest.client.dto.BatchDto;
import org.camunda.community.rest.client.dto.CommentDto;
import org.camunda.community.rest.client.dto.CorrelationMessageAsyncDto;
import org.camunda.community.rest.client.dto.CountResultDto;
import org.camunda.community.rest.client.dto.DeleteProcessInstancesDto;
import org.camunda.community.rest.client.dto.ExceptionDto;
import java.io.File;
import org.camunda.community.rest.client.dto.PatchVariablesDto;
import org.camunda.community.rest.client.dto.ProcessInstanceDto;
import org.camunda.community.rest.client.dto.ProcessInstanceModificationDto;
import org.camunda.community.rest.client.dto.ProcessInstanceQueryDto;
import org.camunda.community.rest.client.dto.ProcessInstanceSuspensionStateAsyncDto;
import org.camunda.community.rest.client.dto.ProcessInstanceSuspensionStateDto;
import org.camunda.community.rest.client.dto.SetJobRetriesByProcessDto;
import org.camunda.community.rest.client.dto.SetVariablesAsyncDto;
import org.camunda.community.rest.client.dto.SuspensionStateDto;
import org.camunda.community.rest.client.dto.VariableValueDto;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.StringJoiner;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-06-27T13:50:23.655629899Z[Etc/UTC]")
public class ProcessInstanceApi {
private ApiClient apiClient;
public ProcessInstanceApi() {
this(Configuration.getDefaultApiClient());
}
public ProcessInstanceApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
public ApiClient getApiClient() {
return apiClient;
}
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Correlate Message Async (POST)
* Correlates a message asynchronously to executions that are waiting for this message. Messages will not be correlated to process definition-level start message events to start process instances.
* @param correlationMessageAsyncDto (optional)
* @return BatchDto
* @throws ApiException if fails to make API call
*/
public BatchDto correlateMessageAsyncOperation(CorrelationMessageAsyncDto correlationMessageAsyncDto) throws ApiException {
return this.correlateMessageAsyncOperation(correlationMessageAsyncDto, Collections.emptyMap());
}
/**
* Correlate Message Async (POST)
* Correlates a message asynchronously to executions that are waiting for this message. Messages will not be correlated to process definition-level start message events to start process instances.
* @param correlationMessageAsyncDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @return BatchDto
* @throws ApiException if fails to make API call
*/
public BatchDto correlateMessageAsyncOperation(CorrelationMessageAsyncDto correlationMessageAsyncDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = correlationMessageAsyncDto;
// create path and map variables
String localVarPath = "/process-instance/message-async";
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference localVarReturnType = new TypeReference() {};
return apiClient.invokeAPI(
localVarPath,
"POST",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* Delete Async Historic Query Based (POST)
* Deletes a set of process instances asynchronously (batch) based on a historic process instance query.
* @param deleteProcessInstancesDto **Unallowed property**: `processInstanceQuery` (optional)
* @return BatchDto
* @throws ApiException if fails to make API call
*/
public BatchDto deleteAsyncHistoricQueryBased(DeleteProcessInstancesDto deleteProcessInstancesDto) throws ApiException {
return this.deleteAsyncHistoricQueryBased(deleteProcessInstancesDto, Collections.emptyMap());
}
/**
* Delete Async Historic Query Based (POST)
* Deletes a set of process instances asynchronously (batch) based on a historic process instance query.
* @param deleteProcessInstancesDto **Unallowed property**: `processInstanceQuery` (optional)
* @param additionalHeaders additionalHeaders for this call
* @return BatchDto
* @throws ApiException if fails to make API call
*/
public BatchDto deleteAsyncHistoricQueryBased(DeleteProcessInstancesDto deleteProcessInstancesDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = deleteProcessInstancesDto;
// create path and map variables
String localVarPath = "/process-instance/delete-historic-query-based";
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference localVarReturnType = new TypeReference() {};
return apiClient.invokeAPI(
localVarPath,
"POST",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* Delete
* Deletes a running process instance by id.
* @param id The id of the process instance to be deleted. (required)
* @param skipCustomListeners If set to true, the custom listeners will be skipped. (optional, default to false)
* @param skipIoMappings If set to true, the input/output mappings will be skipped. (optional, default to false)
* @param skipSubprocesses If set to true, subprocesses related to deleted processes will be skipped. (optional, default to false)
* @param failIfNotExists If set to false, the request will still be successful if the process id is not found. (optional, default to true)
* @throws ApiException if fails to make API call
*/
public void deleteProcessInstance(String id, Boolean skipCustomListeners, Boolean skipIoMappings, Boolean skipSubprocesses, Boolean failIfNotExists) throws ApiException {
this.deleteProcessInstance(id, skipCustomListeners, skipIoMappings, skipSubprocesses, failIfNotExists, Collections.emptyMap());
}
/**
* Delete
* Deletes a running process instance by id.
* @param id The id of the process instance to be deleted. (required)
* @param skipCustomListeners If set to true, the custom listeners will be skipped. (optional, default to false)
* @param skipIoMappings If set to true, the input/output mappings will be skipped. (optional, default to false)
* @param skipSubprocesses If set to true, subprocesses related to deleted processes will be skipped. (optional, default to false)
* @param failIfNotExists If set to false, the request will still be successful if the process id is not found. (optional, default to true)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void deleteProcessInstance(String id, Boolean skipCustomListeners, Boolean skipIoMappings, Boolean skipSubprocesses, Boolean failIfNotExists, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling deleteProcessInstance");
}
// create path and map variables
String localVarPath = "/process-instance/{id}"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPair("skipCustomListeners", skipCustomListeners));
localVarQueryParams.addAll(apiClient.parameterToPair("skipIoMappings", skipIoMappings));
localVarQueryParams.addAll(apiClient.parameterToPair("skipSubprocesses", skipSubprocesses));
localVarQueryParams.addAll(apiClient.parameterToPair("failIfNotExists", failIfNotExists));
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
apiClient.invokeAPI(
localVarPath,
"DELETE",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null
);
}
/**
* Delete Process Variable
* Deletes a variable of a process instance by id.
* @param id The id of the process instance to delete the variable from. (required)
* @param varName The name of the variable to delete. (required)
* @throws ApiException if fails to make API call
*/
public void deleteProcessInstanceVariable(String id, String varName) throws ApiException {
this.deleteProcessInstanceVariable(id, varName, Collections.emptyMap());
}
/**
* Delete Process Variable
* Deletes a variable of a process instance by id.
* @param id The id of the process instance to delete the variable from. (required)
* @param varName The name of the variable to delete. (required)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void deleteProcessInstanceVariable(String id, String varName, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling deleteProcessInstanceVariable");
}
// verify the required parameter 'varName' is set
if (varName == null) {
throw new ApiException(400, "Missing the required parameter 'varName' when calling deleteProcessInstanceVariable");
}
// create path and map variables
String localVarPath = "/process-instance/{id}/variables/{varName}"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()))
.replaceAll("\\{" + "varName" + "\\}", apiClient.escapeString(varName.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
apiClient.invokeAPI(
localVarPath,
"DELETE",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null
);
}
/**
* Delete Async (POST)
* Deletes multiple process instances asynchronously (batch).
* @param deleteProcessInstancesDto **Unallowed property**: `historicProcessInstanceQuery` (optional)
* @return BatchDto
* @throws ApiException if fails to make API call
*/
public BatchDto deleteProcessInstancesAsyncOperation(DeleteProcessInstancesDto deleteProcessInstancesDto) throws ApiException {
return this.deleteProcessInstancesAsyncOperation(deleteProcessInstancesDto, Collections.emptyMap());
}
/**
* Delete Async (POST)
* Deletes multiple process instances asynchronously (batch).
* @param deleteProcessInstancesDto **Unallowed property**: `historicProcessInstanceQuery` (optional)
* @param additionalHeaders additionalHeaders for this call
* @return BatchDto
* @throws ApiException if fails to make API call
*/
public BatchDto deleteProcessInstancesAsyncOperation(DeleteProcessInstancesDto deleteProcessInstancesDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = deleteProcessInstancesDto;
// create path and map variables
String localVarPath = "/process-instance/delete";
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference localVarReturnType = new TypeReference() {};
return apiClient.invokeAPI(
localVarPath,
"POST",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* Get Activity Instance
* Retrieves an Activity Instance (Tree) for a given process instance by id.
* @param id The id of the process instance for which the activity instance should be retrieved. (required)
* @return ActivityInstanceDto
* @throws ApiException if fails to make API call
*/
public ActivityInstanceDto getActivityInstanceTree(String id) throws ApiException {
return this.getActivityInstanceTree(id, Collections.emptyMap());
}
/**
* Get Activity Instance
* Retrieves an Activity Instance (Tree) for a given process instance by id.
* @param id The id of the process instance for which the activity instance should be retrieved. (required)
* @param additionalHeaders additionalHeaders for this call
* @return ActivityInstanceDto
* @throws ApiException if fails to make API call
*/
public ActivityInstanceDto getActivityInstanceTree(String id, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getActivityInstanceTree");
}
// create path and map variables
String localVarPath = "/process-instance/{id}/activity-instances"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference localVarReturnType = new TypeReference() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* Get Process Instance
* Retrieves a process instance by id, according to the `ProcessInstance` interface in the engine.
* @param id The id of the process instance to be retrieved. (required)
* @return ProcessInstanceDto
* @throws ApiException if fails to make API call
*/
public ProcessInstanceDto getProcessInstance(String id) throws ApiException {
return this.getProcessInstance(id, Collections.emptyMap());
}
/**
* Get Process Instance
* Retrieves a process instance by id, according to the `ProcessInstance` interface in the engine.
* @param id The id of the process instance to be retrieved. (required)
* @param additionalHeaders additionalHeaders for this call
* @return ProcessInstanceDto
* @throws ApiException if fails to make API call
*/
public ProcessInstanceDto getProcessInstance(String id, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getProcessInstance");
}
// create path and map variables
String localVarPath = "/process-instance/{id}"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference localVarReturnType = new TypeReference() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* Get Process Instance Comments
* Gets the comments for a process instance by id.
* @param id The id of the process instance to retrieve the comments for. (required)
* @return List<CommentDto>
* @throws ApiException if fails to make API call
*/
public List getProcessInstanceComments(String id) throws ApiException {
return this.getProcessInstanceComments(id, Collections.emptyMap());
}
/**
* Get Process Instance Comments
* Gets the comments for a process instance by id.
* @param id The id of the process instance to retrieve the comments for. (required)
* @param additionalHeaders additionalHeaders for this call
* @return List<CommentDto>
* @throws ApiException if fails to make API call
*/
public List getProcessInstanceComments(String id, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getProcessInstanceComments");
}
// create path and map variables
String localVarPath = "/process-instance/{id}/comment"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference> localVarReturnType = new TypeReference>() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* Get Process Variable
* Retrieves a variable of a given process instance by id.
* @param id The id of the process instance to retrieve the variable for. (required)
* @param varName The name of the variable to retrieve. (required)
* @param deserializeValue Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
* @return VariableValueDto
* @throws ApiException if fails to make API call
*/
public VariableValueDto getProcessInstanceVariable(String id, String varName, Boolean deserializeValue) throws ApiException {
return this.getProcessInstanceVariable(id, varName, deserializeValue, Collections.emptyMap());
}
/**
* Get Process Variable
* Retrieves a variable of a given process instance by id.
* @param id The id of the process instance to retrieve the variable for. (required)
* @param varName The name of the variable to retrieve. (required)
* @param deserializeValue Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
* @param additionalHeaders additionalHeaders for this call
* @return VariableValueDto
* @throws ApiException if fails to make API call
*/
public VariableValueDto getProcessInstanceVariable(String id, String varName, Boolean deserializeValue, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getProcessInstanceVariable");
}
// verify the required parameter 'varName' is set
if (varName == null) {
throw new ApiException(400, "Missing the required parameter 'varName' when calling getProcessInstanceVariable");
}
// create path and map variables
String localVarPath = "/process-instance/{id}/variables/{varName}"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()))
.replaceAll("\\{" + "varName" + "\\}", apiClient.escapeString(varName.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPair("deserializeValue", deserializeValue));
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference localVarReturnType = new TypeReference() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* Get Process Variable (Binary)
* Retrieves the content of a Process Variable by the Process Instance id and the Process Variable name. Applicable for byte array or file Process Variables.
* @param id The id of the process instance to retrieve the variable for. (required)
* @param varName The name of the variable to retrieve. (required)
* @return File
* @throws ApiException if fails to make API call
*/
public File getProcessInstanceVariableBinary(String id, String varName) throws ApiException {
return this.getProcessInstanceVariableBinary(id, varName, Collections.emptyMap());
}
/**
* Get Process Variable (Binary)
* Retrieves the content of a Process Variable by the Process Instance id and the Process Variable name. Applicable for byte array or file Process Variables.
* @param id The id of the process instance to retrieve the variable for. (required)
* @param varName The name of the variable to retrieve. (required)
* @param additionalHeaders additionalHeaders for this call
* @return File
* @throws ApiException if fails to make API call
*/
public File getProcessInstanceVariableBinary(String id, String varName, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getProcessInstanceVariableBinary");
}
// verify the required parameter 'varName' is set
if (varName == null) {
throw new ApiException(400, "Missing the required parameter 'varName' when calling getProcessInstanceVariableBinary");
}
// create path and map variables
String localVarPath = "/process-instance/{id}/variables/{varName}/data"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()))
.replaceAll("\\{" + "varName" + "\\}", apiClient.escapeString(varName.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/octet-stream", "text/plain", "application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference localVarReturnType = new TypeReference() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* Get Process Variables
* Retrieves all variables of a given process instance by id.
* @param id The id of the process instance to retrieve the variables from. (required)
* @param deserializeValues Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
* @return Map<String, VariableValueDto>
* @throws ApiException if fails to make API call
*/
public Map getProcessInstanceVariables(String id, Boolean deserializeValues) throws ApiException {
return this.getProcessInstanceVariables(id, deserializeValues, Collections.emptyMap());
}
/**
* Get Process Variables
* Retrieves all variables of a given process instance by id.
* @param id The id of the process instance to retrieve the variables from. (required)
* @param deserializeValues Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
* @param additionalHeaders additionalHeaders for this call
* @return Map<String, VariableValueDto>
* @throws ApiException if fails to make API call
*/
public Map getProcessInstanceVariables(String id, Boolean deserializeValues, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling getProcessInstanceVariables");
}
// create path and map variables
String localVarPath = "/process-instance/{id}/variables"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPair("deserializeValues", deserializeValues));
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference> localVarReturnType = new TypeReference>() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* Get List
* Queries for process instances that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of process instances. The size of the result set can be retrieved by using the Get Instance Count method.
* @param sortBy Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
* @param sortOrder Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
* @param firstResult Pagination of results. Specifies the index of the first result to return. (optional)
* @param maxResults Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
* @param processInstanceIds Filter by a comma-separated list of process instance ids. (optional)
* @param businessKey Filter by process instance business key. (optional)
* @param businessKeyLike Filter by process instance business key that the parameter is a substring of. (optional)
* @param caseInstanceId Filter by case instance id. (optional)
* @param processDefinitionId Filter by the deployment the id belongs to. (optional)
* @param processDefinitionKey Filter by the key of the process definition the instances run on. (optional)
* @param processDefinitionKeyIn Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys. (optional)
* @param processDefinitionKeyNotIn Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys. (optional)
* @param deploymentId Filter by the deployment the id belongs to. (optional)
* @param superProcessInstance Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)
* @param subProcessInstance Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id. (optional)
* @param superCaseInstance Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)
* @param subCaseInstance Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id. (optional)
* @param active Only include active process instances. Value may only be true, as false is the default behavior. (optional, default to false)
* @param suspended Only include suspended process instances. Value may only be true, as false is the default behavior. (optional, default to false)
* @param withIncident Filter by presence of incidents. Selects only process instances that have an incident. (optional, default to false)
* @param incidentId Filter by the incident id. (optional)
* @param incidentType Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
* @param incidentMessage Filter by the incident message. Exact match. (optional)
* @param incidentMessageLike Filter by the incident message that the parameter is a substring of. (optional)
* @param tenantIdIn Filter by a comma-separated list of tenant ids. A process instance must have one of the given tenant ids. (optional)
* @param withoutTenantId Only include process instances which belong to no tenant. (optional, default to false)
* @param processDefinitionWithoutTenantId Only include process instances which process definition has no tenant id. (optional, default to false)
* @param activityIdIn Filter by a comma-separated list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids. (optional)
* @param rootProcessInstances Restrict the query to all process instances that are top level process instances. (optional, default to false)
* @param leafProcessInstances Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances). (optional, default to false)
* @param variables Only include process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
* @param variableNamesIgnoreCase Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal. (optional, default to false)
* @param variableValuesIgnoreCase Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal. (optional, default to false)
* @return List<ProcessInstanceDto>
* @throws ApiException if fails to make API call
*/
public List getProcessInstances(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String processInstanceIds, String businessKey, String businessKeyLike, String caseInstanceId, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionKeyNotIn, String deploymentId, String superProcessInstance, String subProcessInstance, String superCaseInstance, String subCaseInstance, Boolean active, Boolean suspended, Boolean withIncident, String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String tenantIdIn, Boolean withoutTenantId, Boolean processDefinitionWithoutTenantId, String activityIdIn, Boolean rootProcessInstances, Boolean leafProcessInstances, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase) throws ApiException {
return this.getProcessInstances(sortBy, sortOrder, firstResult, maxResults, processInstanceIds, businessKey, businessKeyLike, caseInstanceId, processDefinitionId, processDefinitionKey, processDefinitionKeyIn, processDefinitionKeyNotIn, deploymentId, superProcessInstance, subProcessInstance, superCaseInstance, subCaseInstance, active, suspended, withIncident, incidentId, incidentType, incidentMessage, incidentMessageLike, tenantIdIn, withoutTenantId, processDefinitionWithoutTenantId, activityIdIn, rootProcessInstances, leafProcessInstances, variables, variableNamesIgnoreCase, variableValuesIgnoreCase, Collections.emptyMap());
}
/**
* Get List
* Queries for process instances that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of process instances. The size of the result set can be retrieved by using the Get Instance Count method.
* @param sortBy Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
* @param sortOrder Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
* @param firstResult Pagination of results. Specifies the index of the first result to return. (optional)
* @param maxResults Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
* @param processInstanceIds Filter by a comma-separated list of process instance ids. (optional)
* @param businessKey Filter by process instance business key. (optional)
* @param businessKeyLike Filter by process instance business key that the parameter is a substring of. (optional)
* @param caseInstanceId Filter by case instance id. (optional)
* @param processDefinitionId Filter by the deployment the id belongs to. (optional)
* @param processDefinitionKey Filter by the key of the process definition the instances run on. (optional)
* @param processDefinitionKeyIn Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys. (optional)
* @param processDefinitionKeyNotIn Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys. (optional)
* @param deploymentId Filter by the deployment the id belongs to. (optional)
* @param superProcessInstance Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)
* @param subProcessInstance Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id. (optional)
* @param superCaseInstance Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)
* @param subCaseInstance Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id. (optional)
* @param active Only include active process instances. Value may only be true, as false is the default behavior. (optional, default to false)
* @param suspended Only include suspended process instances. Value may only be true, as false is the default behavior. (optional, default to false)
* @param withIncident Filter by presence of incidents. Selects only process instances that have an incident. (optional, default to false)
* @param incidentId Filter by the incident id. (optional)
* @param incidentType Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
* @param incidentMessage Filter by the incident message. Exact match. (optional)
* @param incidentMessageLike Filter by the incident message that the parameter is a substring of. (optional)
* @param tenantIdIn Filter by a comma-separated list of tenant ids. A process instance must have one of the given tenant ids. (optional)
* @param withoutTenantId Only include process instances which belong to no tenant. (optional, default to false)
* @param processDefinitionWithoutTenantId Only include process instances which process definition has no tenant id. (optional, default to false)
* @param activityIdIn Filter by a comma-separated list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids. (optional)
* @param rootProcessInstances Restrict the query to all process instances that are top level process instances. (optional, default to false)
* @param leafProcessInstances Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances). (optional, default to false)
* @param variables Only include process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
* @param variableNamesIgnoreCase Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal. (optional, default to false)
* @param variableValuesIgnoreCase Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal. (optional, default to false)
* @param additionalHeaders additionalHeaders for this call
* @return List<ProcessInstanceDto>
* @throws ApiException if fails to make API call
*/
public List getProcessInstances(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String processInstanceIds, String businessKey, String businessKeyLike, String caseInstanceId, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionKeyNotIn, String deploymentId, String superProcessInstance, String subProcessInstance, String superCaseInstance, String subCaseInstance, Boolean active, Boolean suspended, Boolean withIncident, String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String tenantIdIn, Boolean withoutTenantId, Boolean processDefinitionWithoutTenantId, String activityIdIn, Boolean rootProcessInstances, Boolean leafProcessInstances, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/process-instance";
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPair("sortBy", sortBy));
localVarQueryParams.addAll(apiClient.parameterToPair("sortOrder", sortOrder));
localVarQueryParams.addAll(apiClient.parameterToPair("firstResult", firstResult));
localVarQueryParams.addAll(apiClient.parameterToPair("maxResults", maxResults));
localVarQueryParams.addAll(apiClient.parameterToPair("processInstanceIds", processInstanceIds));
localVarQueryParams.addAll(apiClient.parameterToPair("businessKey", businessKey));
localVarQueryParams.addAll(apiClient.parameterToPair("businessKeyLike", businessKeyLike));
localVarQueryParams.addAll(apiClient.parameterToPair("caseInstanceId", caseInstanceId));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionId", processDefinitionId));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionKey", processDefinitionKey));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionKeyIn", processDefinitionKeyIn));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionKeyNotIn", processDefinitionKeyNotIn));
localVarQueryParams.addAll(apiClient.parameterToPair("deploymentId", deploymentId));
localVarQueryParams.addAll(apiClient.parameterToPair("superProcessInstance", superProcessInstance));
localVarQueryParams.addAll(apiClient.parameterToPair("subProcessInstance", subProcessInstance));
localVarQueryParams.addAll(apiClient.parameterToPair("superCaseInstance", superCaseInstance));
localVarQueryParams.addAll(apiClient.parameterToPair("subCaseInstance", subCaseInstance));
localVarQueryParams.addAll(apiClient.parameterToPair("active", active));
localVarQueryParams.addAll(apiClient.parameterToPair("suspended", suspended));
localVarQueryParams.addAll(apiClient.parameterToPair("withIncident", withIncident));
localVarQueryParams.addAll(apiClient.parameterToPair("incidentId", incidentId));
localVarQueryParams.addAll(apiClient.parameterToPair("incidentType", incidentType));
localVarQueryParams.addAll(apiClient.parameterToPair("incidentMessage", incidentMessage));
localVarQueryParams.addAll(apiClient.parameterToPair("incidentMessageLike", incidentMessageLike));
localVarQueryParams.addAll(apiClient.parameterToPair("tenantIdIn", tenantIdIn));
localVarQueryParams.addAll(apiClient.parameterToPair("withoutTenantId", withoutTenantId));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionWithoutTenantId", processDefinitionWithoutTenantId));
localVarQueryParams.addAll(apiClient.parameterToPair("activityIdIn", activityIdIn));
localVarQueryParams.addAll(apiClient.parameterToPair("rootProcessInstances", rootProcessInstances));
localVarQueryParams.addAll(apiClient.parameterToPair("leafProcessInstances", leafProcessInstances));
localVarQueryParams.addAll(apiClient.parameterToPair("variables", variables));
localVarQueryParams.addAll(apiClient.parameterToPair("variableNamesIgnoreCase", variableNamesIgnoreCase));
localVarQueryParams.addAll(apiClient.parameterToPair("variableValuesIgnoreCase", variableValuesIgnoreCase));
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference> localVarReturnType = new TypeReference>() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* Get List Count
* Queries for the number of process instances that fulfill given parameters.
* @param processInstanceIds Filter by a comma-separated list of process instance ids. (optional)
* @param businessKey Filter by process instance business key. (optional)
* @param businessKeyLike Filter by process instance business key that the parameter is a substring of. (optional)
* @param caseInstanceId Filter by case instance id. (optional)
* @param processDefinitionId Filter by the deployment the id belongs to. (optional)
* @param processDefinitionKey Filter by the key of the process definition the instances run on. (optional)
* @param processDefinitionKeyIn Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys. (optional)
* @param processDefinitionKeyNotIn Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys. (optional)
* @param deploymentId Filter by the deployment the id belongs to. (optional)
* @param superProcessInstance Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)
* @param subProcessInstance Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id. (optional)
* @param superCaseInstance Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)
* @param subCaseInstance Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id. (optional)
* @param active Only include active process instances. Value may only be true, as false is the default behavior. (optional, default to false)
* @param suspended Only include suspended process instances. Value may only be true, as false is the default behavior. (optional, default to false)
* @param withIncident Filter by presence of incidents. Selects only process instances that have an incident. (optional, default to false)
* @param incidentId Filter by the incident id. (optional)
* @param incidentType Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
* @param incidentMessage Filter by the incident message. Exact match. (optional)
* @param incidentMessageLike Filter by the incident message that the parameter is a substring of. (optional)
* @param tenantIdIn Filter by a comma-separated list of tenant ids. A process instance must have one of the given tenant ids. (optional)
* @param withoutTenantId Only include process instances which belong to no tenant. (optional, default to false)
* @param processDefinitionWithoutTenantId Only include process instances which process definition has no tenant id. (optional, default to false)
* @param activityIdIn Filter by a comma-separated list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids. (optional)
* @param rootProcessInstances Restrict the query to all process instances that are top level process instances. (optional, default to false)
* @param leafProcessInstances Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances). (optional, default to false)
* @param variables Only include process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
* @param variableNamesIgnoreCase Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal. (optional, default to false)
* @param variableValuesIgnoreCase Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal. (optional, default to false)
* @return CountResultDto
* @throws ApiException if fails to make API call
*/
public CountResultDto getProcessInstancesCount(String processInstanceIds, String businessKey, String businessKeyLike, String caseInstanceId, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionKeyNotIn, String deploymentId, String superProcessInstance, String subProcessInstance, String superCaseInstance, String subCaseInstance, Boolean active, Boolean suspended, Boolean withIncident, String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String tenantIdIn, Boolean withoutTenantId, Boolean processDefinitionWithoutTenantId, String activityIdIn, Boolean rootProcessInstances, Boolean leafProcessInstances, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase) throws ApiException {
return this.getProcessInstancesCount(processInstanceIds, businessKey, businessKeyLike, caseInstanceId, processDefinitionId, processDefinitionKey, processDefinitionKeyIn, processDefinitionKeyNotIn, deploymentId, superProcessInstance, subProcessInstance, superCaseInstance, subCaseInstance, active, suspended, withIncident, incidentId, incidentType, incidentMessage, incidentMessageLike, tenantIdIn, withoutTenantId, processDefinitionWithoutTenantId, activityIdIn, rootProcessInstances, leafProcessInstances, variables, variableNamesIgnoreCase, variableValuesIgnoreCase, Collections.emptyMap());
}
/**
* Get List Count
* Queries for the number of process instances that fulfill given parameters.
* @param processInstanceIds Filter by a comma-separated list of process instance ids. (optional)
* @param businessKey Filter by process instance business key. (optional)
* @param businessKeyLike Filter by process instance business key that the parameter is a substring of. (optional)
* @param caseInstanceId Filter by case instance id. (optional)
* @param processDefinitionId Filter by the deployment the id belongs to. (optional)
* @param processDefinitionKey Filter by the key of the process definition the instances run on. (optional)
* @param processDefinitionKeyIn Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys. (optional)
* @param processDefinitionKeyNotIn Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys. (optional)
* @param deploymentId Filter by the deployment the id belongs to. (optional)
* @param superProcessInstance Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)
* @param subProcessInstance Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id. (optional)
* @param superCaseInstance Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)
* @param subCaseInstance Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id. (optional)
* @param active Only include active process instances. Value may only be true, as false is the default behavior. (optional, default to false)
* @param suspended Only include suspended process instances. Value may only be true, as false is the default behavior. (optional, default to false)
* @param withIncident Filter by presence of incidents. Selects only process instances that have an incident. (optional, default to false)
* @param incidentId Filter by the incident id. (optional)
* @param incidentType Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
* @param incidentMessage Filter by the incident message. Exact match. (optional)
* @param incidentMessageLike Filter by the incident message that the parameter is a substring of. (optional)
* @param tenantIdIn Filter by a comma-separated list of tenant ids. A process instance must have one of the given tenant ids. (optional)
* @param withoutTenantId Only include process instances which belong to no tenant. (optional, default to false)
* @param processDefinitionWithoutTenantId Only include process instances which process definition has no tenant id. (optional, default to false)
* @param activityIdIn Filter by a comma-separated list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids. (optional)
* @param rootProcessInstances Restrict the query to all process instances that are top level process instances. (optional, default to false)
* @param leafProcessInstances Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances). (optional, default to false)
* @param variables Only include process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
* @param variableNamesIgnoreCase Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal. (optional, default to false)
* @param variableValuesIgnoreCase Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal. (optional, default to false)
* @param additionalHeaders additionalHeaders for this call
* @return CountResultDto
* @throws ApiException if fails to make API call
*/
public CountResultDto getProcessInstancesCount(String processInstanceIds, String businessKey, String businessKeyLike, String caseInstanceId, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionKeyNotIn, String deploymentId, String superProcessInstance, String subProcessInstance, String superCaseInstance, String subCaseInstance, Boolean active, Boolean suspended, Boolean withIncident, String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String tenantIdIn, Boolean withoutTenantId, Boolean processDefinitionWithoutTenantId, String activityIdIn, Boolean rootProcessInstances, Boolean leafProcessInstances, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/process-instance/count";
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPair("processInstanceIds", processInstanceIds));
localVarQueryParams.addAll(apiClient.parameterToPair("businessKey", businessKey));
localVarQueryParams.addAll(apiClient.parameterToPair("businessKeyLike", businessKeyLike));
localVarQueryParams.addAll(apiClient.parameterToPair("caseInstanceId", caseInstanceId));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionId", processDefinitionId));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionKey", processDefinitionKey));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionKeyIn", processDefinitionKeyIn));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionKeyNotIn", processDefinitionKeyNotIn));
localVarQueryParams.addAll(apiClient.parameterToPair("deploymentId", deploymentId));
localVarQueryParams.addAll(apiClient.parameterToPair("superProcessInstance", superProcessInstance));
localVarQueryParams.addAll(apiClient.parameterToPair("subProcessInstance", subProcessInstance));
localVarQueryParams.addAll(apiClient.parameterToPair("superCaseInstance", superCaseInstance));
localVarQueryParams.addAll(apiClient.parameterToPair("subCaseInstance", subCaseInstance));
localVarQueryParams.addAll(apiClient.parameterToPair("active", active));
localVarQueryParams.addAll(apiClient.parameterToPair("suspended", suspended));
localVarQueryParams.addAll(apiClient.parameterToPair("withIncident", withIncident));
localVarQueryParams.addAll(apiClient.parameterToPair("incidentId", incidentId));
localVarQueryParams.addAll(apiClient.parameterToPair("incidentType", incidentType));
localVarQueryParams.addAll(apiClient.parameterToPair("incidentMessage", incidentMessage));
localVarQueryParams.addAll(apiClient.parameterToPair("incidentMessageLike", incidentMessageLike));
localVarQueryParams.addAll(apiClient.parameterToPair("tenantIdIn", tenantIdIn));
localVarQueryParams.addAll(apiClient.parameterToPair("withoutTenantId", withoutTenantId));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionWithoutTenantId", processDefinitionWithoutTenantId));
localVarQueryParams.addAll(apiClient.parameterToPair("activityIdIn", activityIdIn));
localVarQueryParams.addAll(apiClient.parameterToPair("rootProcessInstances", rootProcessInstances));
localVarQueryParams.addAll(apiClient.parameterToPair("leafProcessInstances", leafProcessInstances));
localVarQueryParams.addAll(apiClient.parameterToPair("variables", variables));
localVarQueryParams.addAll(apiClient.parameterToPair("variableNamesIgnoreCase", variableNamesIgnoreCase));
localVarQueryParams.addAll(apiClient.parameterToPair("variableValuesIgnoreCase", variableValuesIgnoreCase));
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference localVarReturnType = new TypeReference() {};
return apiClient.invokeAPI(
localVarPath,
"GET",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* Modify Process Instance Execution State
* Submits a list of modification instructions to change a process instance's execution state. A modification instruction is one of the following: * Starting execution before an activity * Starting execution after an activity on its single outgoing sequence flow * Starting execution on a specific sequence flow * Canceling an activity instance, transition instance, or all instances (activity or transition) for an activity Instructions are executed immediately and in the order they are provided in this request's body. Variables can be provided with every starting instruction. The exact semantics of modification can be read about in the [User guide](https://docs.camunda.org/manual/develop/user-guide/process-engine/process-instance-modification/).
* @param id The id of the process instance to modify. (required)
* @param processInstanceModificationDto (optional)
* @throws ApiException if fails to make API call
*/
public void modifyProcessInstance(String id, ProcessInstanceModificationDto processInstanceModificationDto) throws ApiException {
this.modifyProcessInstance(id, processInstanceModificationDto, Collections.emptyMap());
}
/**
* Modify Process Instance Execution State
* Submits a list of modification instructions to change a process instance's execution state. A modification instruction is one of the following: * Starting execution before an activity * Starting execution after an activity on its single outgoing sequence flow * Starting execution on a specific sequence flow * Canceling an activity instance, transition instance, or all instances (activity or transition) for an activity Instructions are executed immediately and in the order they are provided in this request's body. Variables can be provided with every starting instruction. The exact semantics of modification can be read about in the [User guide](https://docs.camunda.org/manual/develop/user-guide/process-engine/process-instance-modification/).
* @param id The id of the process instance to modify. (required)
* @param processInstanceModificationDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void modifyProcessInstance(String id, ProcessInstanceModificationDto processInstanceModificationDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = processInstanceModificationDto;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling modifyProcessInstance");
}
// create path and map variables
String localVarPath = "/process-instance/{id}/modification"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
apiClient.invokeAPI(
localVarPath,
"POST",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null
);
}
/**
* Modify Process Instance Execution State Async
* Submits a list of modification instructions to change a process instance's execution state async. A modification instruction is one of the following: * Starting execution before an activity * Starting execution after an activity on its single outgoing sequence flow * Starting execution on a specific sequence flow * Cancelling an activity instance, transition instance, or all instances (activity or transition) for an activity Instructions are executed asynchronous and in the order they are provided in this request's body. Variables can be provided with every starting instruction. The exact semantics of modification can be read about in the [User guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-instance-modification/).
* @param id The id of the process instance to modify. (required)
* @param processInstanceModificationDto (optional)
* @return BatchDto
* @throws ApiException if fails to make API call
*/
public BatchDto modifyProcessInstanceAsyncOperation(String id, ProcessInstanceModificationDto processInstanceModificationDto) throws ApiException {
return this.modifyProcessInstanceAsyncOperation(id, processInstanceModificationDto, Collections.emptyMap());
}
/**
* Modify Process Instance Execution State Async
* Submits a list of modification instructions to change a process instance's execution state async. A modification instruction is one of the following: * Starting execution before an activity * Starting execution after an activity on its single outgoing sequence flow * Starting execution on a specific sequence flow * Cancelling an activity instance, transition instance, or all instances (activity or transition) for an activity Instructions are executed asynchronous and in the order they are provided in this request's body. Variables can be provided with every starting instruction. The exact semantics of modification can be read about in the [User guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-instance-modification/).
* @param id The id of the process instance to modify. (required)
* @param processInstanceModificationDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @return BatchDto
* @throws ApiException if fails to make API call
*/
public BatchDto modifyProcessInstanceAsyncOperation(String id, ProcessInstanceModificationDto processInstanceModificationDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = processInstanceModificationDto;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling modifyProcessInstanceAsyncOperation");
}
// create path and map variables
String localVarPath = "/process-instance/{id}/modification-async"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference localVarReturnType = new TypeReference() {};
return apiClient.invokeAPI(
localVarPath,
"POST",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* Update/Delete Process Variables
* Updates or deletes the variables of a process instance by id. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.
* @param id The id of the process instance to set variables for. (required)
* @param patchVariablesDto (optional)
* @throws ApiException if fails to make API call
*/
public void modifyProcessInstanceVariables(String id, PatchVariablesDto patchVariablesDto) throws ApiException {
this.modifyProcessInstanceVariables(id, patchVariablesDto, Collections.emptyMap());
}
/**
* Update/Delete Process Variables
* Updates or deletes the variables of a process instance by id. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.
* @param id The id of the process instance to set variables for. (required)
* @param patchVariablesDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void modifyProcessInstanceVariables(String id, PatchVariablesDto patchVariablesDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = patchVariablesDto;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling modifyProcessInstanceVariables");
}
// create path and map variables
String localVarPath = "/process-instance/{id}/variables"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
apiClient.invokeAPI(
localVarPath,
"POST",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null
);
}
/**
* Get List (POST)
* Queries for process instances that fulfill given parameters through a JSON object. This method is slightly more powerful than the Get Instances method because it allows filtering by multiple process variables of types `string`, `number` or `boolean`.
* @param firstResult Pagination of results. Specifies the index of the first result to return. (optional)
* @param maxResults Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
* @param processInstanceQueryDto (optional)
* @return List<ProcessInstanceDto>
* @throws ApiException if fails to make API call
*/
public List queryProcessInstances(Integer firstResult, Integer maxResults, ProcessInstanceQueryDto processInstanceQueryDto) throws ApiException {
return this.queryProcessInstances(firstResult, maxResults, processInstanceQueryDto, Collections.emptyMap());
}
/**
* Get List (POST)
* Queries for process instances that fulfill given parameters through a JSON object. This method is slightly more powerful than the Get Instances method because it allows filtering by multiple process variables of types `string`, `number` or `boolean`.
* @param firstResult Pagination of results. Specifies the index of the first result to return. (optional)
* @param maxResults Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
* @param processInstanceQueryDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @return List<ProcessInstanceDto>
* @throws ApiException if fails to make API call
*/
public List queryProcessInstances(Integer firstResult, Integer maxResults, ProcessInstanceQueryDto processInstanceQueryDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = processInstanceQueryDto;
// create path and map variables
String localVarPath = "/process-instance";
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarQueryParams.addAll(apiClient.parameterToPair("firstResult", firstResult));
localVarQueryParams.addAll(apiClient.parameterToPair("maxResults", maxResults));
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference> localVarReturnType = new TypeReference>() {};
return apiClient.invokeAPI(
localVarPath,
"POST",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* Get List Count (POST)
* Queries for the number of process instances that fulfill the given parameters. This method takes the same message body as the Get Instances (POST) method and therefore it is slightly more powerful than the Get Instance Count method.
* @param processInstanceQueryDto (optional)
* @return CountResultDto
* @throws ApiException if fails to make API call
*/
public CountResultDto queryProcessInstancesCount(ProcessInstanceQueryDto processInstanceQueryDto) throws ApiException {
return this.queryProcessInstancesCount(processInstanceQueryDto, Collections.emptyMap());
}
/**
* Get List Count (POST)
* Queries for the number of process instances that fulfill the given parameters. This method takes the same message body as the Get Instances (POST) method and therefore it is slightly more powerful than the Get Instance Count method.
* @param processInstanceQueryDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @return CountResultDto
* @throws ApiException if fails to make API call
*/
public CountResultDto queryProcessInstancesCount(ProcessInstanceQueryDto processInstanceQueryDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = processInstanceQueryDto;
// create path and map variables
String localVarPath = "/process-instance/count";
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
TypeReference localVarReturnType = new TypeReference() {};
return apiClient.invokeAPI(
localVarPath,
"POST",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType
);
}
/**
* Update Process Variable
* Sets a variable of a given process instance by id.
* @param id The id of the process instance to set the variable for. (required)
* @param varName The name of the variable to set. (required)
* @param variableValueDto (optional)
* @throws ApiException if fails to make API call
*/
public void setProcessInstanceVariable(String id, String varName, VariableValueDto variableValueDto) throws ApiException {
this.setProcessInstanceVariable(id, varName, variableValueDto, Collections.emptyMap());
}
/**
* Update Process Variable
* Sets a variable of a given process instance by id.
* @param id The id of the process instance to set the variable for. (required)
* @param varName The name of the variable to set. (required)
* @param variableValueDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void setProcessInstanceVariable(String id, String varName, VariableValueDto variableValueDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = variableValueDto;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling setProcessInstanceVariable");
}
// verify the required parameter 'varName' is set
if (varName == null) {
throw new ApiException(400, "Missing the required parameter 'varName' when calling setProcessInstanceVariable");
}
// create path and map variables
String localVarPath = "/process-instance/{id}/variables/{varName}"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()))
.replaceAll("\\{" + "varName" + "\\}", apiClient.escapeString(varName.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
localVarHeaderParams.putAll(additionalHeaders);
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "basicAuth" };
apiClient.invokeAPI(
localVarPath,
"PUT",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null
);
}
/**
* Update Process Variable (Binary)
* Sets the serialized value for a binary variable or the binary value for a file variable.
* @param id The id of the process instance to retrieve the variable for. (required)
* @param varName The name of the variable to retrieve. (required)
* @param data The binary data to be set. For File variables, this multipart can contain the filename, binary value and MIME type of the file variable to be set Only the filename is mandatory. (optional)
* @param valueType The name of the variable type. Either Bytes for a byte array variable or File for a file variable. (optional)
* @throws ApiException if fails to make API call
*/
public void setProcessInstanceVariableBinary(String id, String varName, File data, String valueType) throws ApiException {
this.setProcessInstanceVariableBinary(id, varName, data, valueType, Collections.emptyMap());
}
/**
* Update Process Variable (Binary)
* Sets the serialized value for a binary variable or the binary value for a file variable.
* @param id The id of the process instance to retrieve the variable for. (required)
* @param varName The name of the variable to retrieve. (required)
* @param data The binary data to be set. For File variables, this multipart can contain the filename, binary value and MIME type of the file variable to be set Only the filename is mandatory. (optional)
* @param valueType The name of the variable type. Either Bytes for a byte array variable or File for a file variable. (optional)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void setProcessInstanceVariableBinary(String id, String varName, File data, String valueType, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling setProcessInstanceVariableBinary");
}
// verify the required parameter 'varName' is set
if (varName == null) {
throw new ApiException(400, "Missing the required parameter 'varName' when calling setProcessInstanceVariableBinary");
}
// create path and map variables
String localVarPath = "/process-instance/{id}/variables/{varName}/data"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()))
.replaceAll("\\{" + "varName" + "\\}", apiClient.escapeString(varName.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList
