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.AuthorizationExceptionDto;
import org.camunda.community.rest.client.dto.CompleteTaskDto;
import org.camunda.community.rest.client.dto.CountResultDto;
import org.camunda.community.rest.client.dto.ExceptionDto;
import java.io.File;
import org.camunda.community.rest.client.dto.FormDto;
import org.camunda.community.rest.client.dto.TaskBpmnErrorDto;
import org.camunda.community.rest.client.dto.TaskCountByCandidateGroupResultDto;
import org.camunda.community.rest.client.dto.TaskDto;
import org.camunda.community.rest.client.dto.TaskEscalationDto;
import org.camunda.community.rest.client.dto.TaskQueryDto;
import org.camunda.community.rest.client.dto.UserIdDto;
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 TaskApi {
private ApiClient apiClient;
public TaskApi() {
this(Configuration.getDefaultApiClient());
}
public TaskApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
public ApiClient getApiClient() {
return apiClient;
}
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Claim
* Claims a task for a specific user. **Note:** The difference with the [Set Assignee](https://docs.camunda.org/manual/7.21/reference/rest/task/post-assignee/) method is that here a check is performed to see if the task already has a user assigned to it.
* @param id The id of the task to claim. (required)
* @param userIdDto Provide the id of the user that claims the task. (optional)
* @throws ApiException if fails to make API call
*/
public void claim(String id, UserIdDto userIdDto) throws ApiException {
this.claim(id, userIdDto, Collections.emptyMap());
}
/**
* Claim
* Claims a task for a specific user. **Note:** The difference with the [Set Assignee](https://docs.camunda.org/manual/7.21/reference/rest/task/post-assignee/) method is that here a check is performed to see if the task already has a user assigned to it.
* @param id The id of the task to claim. (required)
* @param userIdDto Provide the id of the user that claims the task. (optional)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void claim(String id, UserIdDto userIdDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = userIdDto;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling claim");
}
// create path and map variables
String localVarPath = "/task/{id}/claim"
.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
);
}
/**
* Complete
* Completes a task and updates process variables.
* @param id The id of the task to complete. (required)
* @param completeTaskDto (optional)
* @return Map<String, VariableValueDto>
* @throws ApiException if fails to make API call
*/
public Map complete(String id, CompleteTaskDto completeTaskDto) throws ApiException {
return this.complete(id, completeTaskDto, Collections.emptyMap());
}
/**
* Complete
* Completes a task and updates process variables.
* @param id The id of the task to complete. (required)
* @param completeTaskDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @return Map<String, VariableValueDto>
* @throws ApiException if fails to make API call
*/
public Map complete(String id, CompleteTaskDto completeTaskDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = completeTaskDto;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling complete");
}
// create path and map variables
String localVarPath = "/task/{id}/complete"
.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
);
}
/**
* Create
* Creates a new task.
* @param taskDto (optional)
* @throws ApiException if fails to make API call
*/
public void createTask(TaskDto taskDto) throws ApiException {
this.createTask(taskDto, Collections.emptyMap());
}
/**
* Create
* Creates a new task.
* @param taskDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void createTask(TaskDto taskDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = taskDto;
// create path and map variables
String localVarPath = "/task/create";
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
);
}
/**
* Delegate
* Delegates a task to another user.
* @param id The id of the task to delegate. (required)
* @param userIdDto Provide the id of the user that the task should be delegated to. (optional)
* @throws ApiException if fails to make API call
*/
public void delegateTask(String id, UserIdDto userIdDto) throws ApiException {
this.delegateTask(id, userIdDto, Collections.emptyMap());
}
/**
* Delegate
* Delegates a task to another user.
* @param id The id of the task to delegate. (required)
* @param userIdDto Provide the id of the user that the task should be delegated to. (optional)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void delegateTask(String id, UserIdDto userIdDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = userIdDto;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling delegateTask");
}
// create path and map variables
String localVarPath = "/task/{id}/delegate"
.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
);
}
/**
* Delete
* Removes a task by id.
* @param id The id of the task to be removed. (required)
* @throws ApiException if fails to make API call
*/
public void deleteTask(String id) throws ApiException {
this.deleteTask(id, Collections.emptyMap());
}
/**
* Delete
* Removes a task by id.
* @param id The id of the task to be removed. (required)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void deleteTask(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 deleteTask");
}
// create path and map variables
String localVarPath = "/task/{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" };
apiClient.invokeAPI(
localVarPath,
"DELETE",
localVarQueryParams,
localVarCollectionQueryParams,
localVarQueryStringJoiner.toString(),
localVarPostBody,
localVarHeaderParams,
localVarCookieParams,
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null
);
}
/**
* Get Deployed Form
* Retrieves the deployed form that is referenced from a given task. For further information please refer to the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#embedded-task-forms).
* @param id The id of the task to get the deployed form for. (required)
* @return File
* @throws ApiException if fails to make API call
*/
public File getDeployedForm(String id) throws ApiException {
return this.getDeployedForm(id, Collections.emptyMap());
}
/**
* Get Deployed Form
* Retrieves the deployed form that is referenced from a given task. For further information please refer to the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#embedded-task-forms).
* @param id The id of the task to get the deployed form for. (required)
* @param additionalHeaders additionalHeaders for this call
* @return File
* @throws ApiException if fails to make API call
*/
public File getDeployedForm(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 getDeployedForm");
}
// create path and map variables
String localVarPath = "/task/{id}/deployed-form"
.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/xhtml+xml", "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 Form Key
* Retrieves the form key for a task. The form key corresponds to the `FormData#formKey` property in the engine. This key can be used to do task-specific form rendering in client applications. Additionally, the context path of the containing process application is returned.
* @param id The id of the task to retrieve the form for. (required)
* @return FormDto
* @throws ApiException if fails to make API call
*/
public FormDto getForm(String id) throws ApiException {
return this.getForm(id, Collections.emptyMap());
}
/**
* Get Form Key
* Retrieves the form key for a task. The form key corresponds to the `FormData#formKey` property in the engine. This key can be used to do task-specific form rendering in client applications. Additionally, the context path of the containing process application is returned.
* @param id The id of the task to retrieve the form for. (required)
* @param additionalHeaders additionalHeaders for this call
* @return FormDto
* @throws ApiException if fails to make API call
*/
public FormDto getForm(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 getForm");
}
// create path and map variables
String localVarPath = "/task/{id}/form"
.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 Task Form Variables
* Retrieves the form variables for a task. The form variables take form data specified on the task into account. If form fields are defined, the variable types and default values of the form fields are taken into account.
* @param id The id of the task to retrieve the variables for. (required)
* @param variableNames A comma-separated list of variable names. Allows restricting the list of requested variables to the variable names in the list. It is best practice to restrict the list of variables to the variables actually required by the form in order to minimize fetching of data. If the query parameter is ommitted all variables are fetched. If the query parameter contains non-existent variable names, the variable names are ignored. (optional)
* @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](http://jackson.codehaus.org/) 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 getFormVariables(String id, String variableNames, Boolean deserializeValues) throws ApiException {
return this.getFormVariables(id, variableNames, deserializeValues, Collections.emptyMap());
}
/**
* Get Task Form Variables
* Retrieves the form variables for a task. The form variables take form data specified on the task into account. If form fields are defined, the variable types and default values of the form fields are taken into account.
* @param id The id of the task to retrieve the variables for. (required)
* @param variableNames A comma-separated list of variable names. Allows restricting the list of requested variables to the variable names in the list. It is best practice to restrict the list of variables to the variables actually required by the form in order to minimize fetching of data. If the query parameter is ommitted all variables are fetched. If the query parameter contains non-existent variable names, the variable names are ignored. (optional)
* @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](http://jackson.codehaus.org/) 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 getFormVariables(String id, String variableNames, 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 getFormVariables");
}
// create path and map variables
String localVarPath = "/task/{id}/form-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("variableNames", variableNames));
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 Rendered Form
* Retrieves the rendered form for a task. This method can be used to get the HTML rendering of a [Generated Task Form](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms).
* @param id The id of the task to get the rendered form for. (required)
* @return File
* @throws ApiException if fails to make API call
*/
public File getRenderedForm(String id) throws ApiException {
return this.getRenderedForm(id, Collections.emptyMap());
}
/**
* Get Rendered Form
* Retrieves the rendered form for a task. This method can be used to get the HTML rendering of a [Generated Task Form](https://docs.camunda.org/manual/7.21/user-guide/task-forms/#generated-task-forms).
* @param id The id of the task to get the rendered form for. (required)
* @param additionalHeaders additionalHeaders for this call
* @return File
* @throws ApiException if fails to make API call
*/
public File getRenderedForm(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 getRenderedForm");
}
// create path and map variables
String localVarPath = "/task/{id}/rendered-form"
.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/xhtml+xml", "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
* Retrieves a task by id.
* @param id The id of the task to be retrieved. (required)
* @return TaskDto
* @throws ApiException if fails to make API call
*/
public TaskDto getTask(String id) throws ApiException {
return this.getTask(id, Collections.emptyMap());
}
/**
* Get
* Retrieves a task by id.
* @param id The id of the task to be retrieved. (required)
* @param additionalHeaders additionalHeaders for this call
* @return TaskDto
* @throws ApiException if fails to make API call
*/
public TaskDto getTask(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 getTask");
}
// create path and map variables
String localVarPath = "/task/{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 Task Count By Candidate Group
* Retrieves the number of tasks for each candidate group.
* @return List<TaskCountByCandidateGroupResultDto>
* @throws ApiException if fails to make API call
*/
public List getTaskCountByCandidateGroup() throws ApiException {
return this.getTaskCountByCandidateGroup(Collections.emptyMap());
}
/**
* Get Task Count By Candidate Group
* Retrieves the number of tasks for each candidate group.
* @param additionalHeaders additionalHeaders for this call
* @return List<TaskCountByCandidateGroupResultDto>
* @throws ApiException if fails to make API call
*/
public List getTaskCountByCandidateGroup(Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/task/report/candidate-group-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", "application/csv", "text/csv"
};
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 tasks that fulfill a given filter. The size of the result set can be retrieved by using the Get Task Count method. **Security Consideration:** There are several query parameters (such as assigneeExpression) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on [security considerations](https://docs.camunda.org/manual/7.21/user-guide/process-engine/securing-custom-code/) for custom code in the user guide for details.
* @param taskId Restrict to task with the given id. (optional)
* @param taskIdIn Restrict to tasks with any of the given ids. (optional)
* @param processInstanceId Restrict to tasks that belong to process instances with the given id. (optional)
* @param processInstanceIdIn Restrict to tasks that belong to process instances with the given ids. (optional)
* @param processInstanceBusinessKey Restrict to tasks that belong to process instances with the given business key. (optional)
* @param processInstanceBusinessKeyExpression Restrict to tasks that belong to process instances with the given business key which is described by an expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param processInstanceBusinessKeyIn Restrict to tasks that belong to process instances with one of the give business keys. The keys need to be in a comma-separated list. (optional)
* @param processInstanceBusinessKeyLike Restrict to tasks that have a process instance business key that has the parameter value as a substring. (optional)
* @param processInstanceBusinessKeyLikeExpression Restrict to tasks that have a process instance business key that has the parameter value as a substring and is described by an expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param processDefinitionId Restrict to tasks that belong to a process definition with the given id. (optional)
* @param processDefinitionKey Restrict to tasks that belong to a process definition with the given key. (optional)
* @param processDefinitionKeyIn Restrict to tasks that belong to a process definition with one of the given keys. The keys need to be in a comma-separated list. (optional)
* @param processDefinitionName Restrict to tasks that belong to a process definition with the given name. (optional)
* @param processDefinitionNameLike Restrict to tasks that have a process definition name that has the parameter value as a substring. (optional)
* @param executionId Restrict to tasks that belong to an execution with the given id. (optional)
* @param caseInstanceId Restrict to tasks that belong to case instances with the given id. (optional)
* @param caseInstanceBusinessKey Restrict to tasks that belong to case instances with the given business key. (optional)
* @param caseInstanceBusinessKeyLike Restrict to tasks that have a case instance business key that has the parameter value as a substring. (optional)
* @param caseDefinitionId Restrict to tasks that belong to a case definition with the given id. (optional)
* @param caseDefinitionKey Restrict to tasks that belong to a case definition with the given key. (optional)
* @param caseDefinitionName Restrict to tasks that belong to a case definition with the given name. (optional)
* @param caseDefinitionNameLike Restrict to tasks that have a case definition name that has the parameter value as a substring. (optional)
* @param caseExecutionId Restrict to tasks that belong to a case execution with the given id. (optional)
* @param activityInstanceIdIn Only include tasks which belong to one of the passed and comma-separated activity instance ids. (optional)
* @param tenantIdIn Only include tasks which belong to one of the passed and comma-separated tenant ids. (optional)
* @param withoutTenantId Only include tasks which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param assignee Restrict to tasks that the given user is assigned to. (optional)
* @param assigneeExpression Restrict to tasks that the user described by the given expression is assigned to. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param assigneeLike Restrict to tasks that have an assignee that has the parameter value as a substring. (optional)
* @param assigneeLikeExpression Restrict to tasks that have an assignee that has the parameter value described by the given expression as a substring. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param assigneeIn Only include tasks which are assigned to one of the passed and comma-separated user ids. (optional)
* @param assigneeNotIn Only include tasks which are not assigned to one of the passed and comma-separated user ids. (optional)
* @param owner Restrict to tasks that the given user owns. (optional)
* @param ownerExpression Restrict to tasks that the user described by the given expression owns. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param candidateGroup Only include tasks that are offered to the given group. (optional)
* @param candidateGroupExpression Only include tasks that are offered to the group described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param candidateUser Only include tasks that are offered to the given user or to one of his groups. (optional)
* @param candidateUserExpression Only include tasks that are offered to the user described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param includeAssignedTasks Also include tasks that are assigned to users in candidate queries. Default is to only include tasks that are not assigned to any user if you query by candidate user or group(s). (optional, default to false)
* @param involvedUser Only include tasks that the given user is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee). (optional)
* @param involvedUserExpression Only include tasks that the user described by the given expression is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee). See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param assigned If set to `true`, restricts the query to all tasks that are assigned. (optional, default to false)
* @param unassigned If set to `true`, restricts the query to all tasks that are unassigned. (optional, default to false)
* @param taskDefinitionKey Restrict to tasks that have the given key. (optional)
* @param taskDefinitionKeyIn Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list. (optional)
* @param taskDefinitionKeyLike Restrict to tasks that have a key that has the parameter value as a substring. (optional)
* @param name Restrict to tasks that have the given name. (optional)
* @param nameNotEqual Restrict to tasks that do not have the given name. (optional)
* @param nameLike Restrict to tasks that have a name with the given parameter value as substring. (optional)
* @param nameNotLike Restrict to tasks that do not have a name with the given parameter value as substring. (optional)
* @param description Restrict to tasks that have the given description. (optional)
* @param descriptionLike Restrict to tasks that have a description that has the parameter value as a substring. (optional)
* @param priority Restrict to tasks that have the given priority. (optional)
* @param maxPriority Restrict to tasks that have a lower or equal priority. (optional)
* @param minPriority Restrict to tasks that have a higher or equal priority. (optional)
* @param dueDate Restrict to tasks that are due on the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.546+0200`. (optional)
* @param dueDateExpression Restrict to tasks that are due on the date described by the given expression. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param dueAfter Restrict to tasks that are due after the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.435+0200`. (optional)
* @param dueAfterExpression Restrict to tasks that are due after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param dueBefore Restrict to tasks that are due before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.243+0200`. (optional)
* @param dueBeforeExpression Restrict to tasks that are due before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param withoutDueDate Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param followUpDate Restrict to tasks that have a followUp date on the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.342+0200`. (optional)
* @param followUpDateExpression Restrict to tasks that have a followUp date on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param followUpAfter Restrict to tasks that have a followUp date after the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.542+0200`. (optional)
* @param followUpAfterExpression Restrict to tasks that have a followUp date after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param followUpBefore Restrict to tasks that have a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.234+0200`. (optional)
* @param followUpBeforeExpression Restrict to tasks that have a followUp date before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param followUpBeforeOrNotExistent Restrict to tasks that have no followUp date or a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.432+0200`. The typical use case is to query all `active` tasks for a user for a given date. (optional)
* @param followUpBeforeOrNotExistentExpression Restrict to tasks that have no followUp date or a followUp date before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param createdOn Restrict to tasks that were created on the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.324+0200`. (optional)
* @param createdOnExpression Restrict to tasks that were created on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param createdAfter Restrict to tasks that were created after the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.342+0200`. (optional)
* @param createdAfterExpression Restrict to tasks that were created after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param createdBefore Restrict to tasks that were created before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.332+0200`. (optional)
* @param createdBeforeExpression Restrict to tasks that were created before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param updatedAfter Restrict to tasks that were updated after the given date. Every action that fires a [task update event](https://docs.camunda.org/manual/7.21/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.332+0200`. (optional)
* @param updatedAfterExpression Restrict to tasks that were updated after the date described by the given expression. Every action that fires a [task update event](https://docs.camunda.org/manual/7.21/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param delegationState Restrict to tasks that are in the given delegation state. Valid values are `PENDING` and `RESOLVED`. (optional)
* @param candidateGroups Restrict to tasks that are offered to any of the given candidate groups. Takes a comma-separated list of group names, so for example `developers,support,sales`. (optional)
* @param candidateGroupsExpression Restrict to tasks that are offered to any of the candidate groups described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to `java.util.List` of Strings. (optional)
* @param withCandidateGroups Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param withoutCandidateGroups Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param withCandidateUsers Only include tasks which have a candidate user. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param withoutCandidateUsers Only include tasks which have no candidate users. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param active Only include active tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param suspended Only include suspended tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param taskVariables Only include tasks 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 processVariables Only include tasks that belong to 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`; `notLike`. `key` and `value` may not contain underscore or comma characters. (optional)
* @param caseInstanceVariables Only include tasks that belong to case 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 `variableName` and `variablename` are treated as equal. (optional, default to false)
* @param variableValuesIgnoreCase Match all variable values in this query case-insensitively. If set `variableValue` and `variablevalue` are treated as equal. (optional, default to false)
* @param parentTaskId Restrict query to all tasks that are sub tasks of the given task. Takes a task id. (optional)
* @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)
* @return List<TaskDto>
* @throws ApiException if fails to make API call
*/
public List getTasks(String taskId, String taskIdIn, String processInstanceId, String processInstanceIdIn, String processInstanceBusinessKey, String processInstanceBusinessKeyExpression, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String processInstanceBusinessKeyLikeExpression, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionName, String processDefinitionNameLike, String executionId, String caseInstanceId, String caseInstanceBusinessKey, String caseInstanceBusinessKeyLike, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String caseDefinitionNameLike, String caseExecutionId, String activityInstanceIdIn, String tenantIdIn, Boolean withoutTenantId, String assignee, String assigneeExpression, String assigneeLike, String assigneeLikeExpression, String assigneeIn, String assigneeNotIn, String owner, String ownerExpression, String candidateGroup, String candidateGroupExpression, String candidateUser, String candidateUserExpression, Boolean includeAssignedTasks, String involvedUser, String involvedUserExpression, Boolean assigned, Boolean unassigned, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDefinitionKeyLike, String name, String nameNotEqual, String nameLike, String nameNotLike, String description, String descriptionLike, Integer priority, Integer maxPriority, Integer minPriority, String dueDate, String dueDateExpression, String dueAfter, String dueAfterExpression, String dueBefore, String dueBeforeExpression, Boolean withoutDueDate, String followUpDate, String followUpDateExpression, String followUpAfter, String followUpAfterExpression, String followUpBefore, String followUpBeforeExpression, String followUpBeforeOrNotExistent, String followUpBeforeOrNotExistentExpression, String createdOn, String createdOnExpression, String createdAfter, String createdAfterExpression, String createdBefore, String createdBeforeExpression, String updatedAfter, String updatedAfterExpression, String delegationState, String candidateGroups, String candidateGroupsExpression, Boolean withCandidateGroups, Boolean withoutCandidateGroups, Boolean withCandidateUsers, Boolean withoutCandidateUsers, Boolean active, Boolean suspended, String taskVariables, String processVariables, String caseInstanceVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String parentTaskId, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) throws ApiException {
return this.getTasks(taskId, taskIdIn, processInstanceId, processInstanceIdIn, processInstanceBusinessKey, processInstanceBusinessKeyExpression, processInstanceBusinessKeyIn, processInstanceBusinessKeyLike, processInstanceBusinessKeyLikeExpression, processDefinitionId, processDefinitionKey, processDefinitionKeyIn, processDefinitionName, processDefinitionNameLike, executionId, caseInstanceId, caseInstanceBusinessKey, caseInstanceBusinessKeyLike, caseDefinitionId, caseDefinitionKey, caseDefinitionName, caseDefinitionNameLike, caseExecutionId, activityInstanceIdIn, tenantIdIn, withoutTenantId, assignee, assigneeExpression, assigneeLike, assigneeLikeExpression, assigneeIn, assigneeNotIn, owner, ownerExpression, candidateGroup, candidateGroupExpression, candidateUser, candidateUserExpression, includeAssignedTasks, involvedUser, involvedUserExpression, assigned, unassigned, taskDefinitionKey, taskDefinitionKeyIn, taskDefinitionKeyLike, name, nameNotEqual, nameLike, nameNotLike, description, descriptionLike, priority, maxPriority, minPriority, dueDate, dueDateExpression, dueAfter, dueAfterExpression, dueBefore, dueBeforeExpression, withoutDueDate, followUpDate, followUpDateExpression, followUpAfter, followUpAfterExpression, followUpBefore, followUpBeforeExpression, followUpBeforeOrNotExistent, followUpBeforeOrNotExistentExpression, createdOn, createdOnExpression, createdAfter, createdAfterExpression, createdBefore, createdBeforeExpression, updatedAfter, updatedAfterExpression, delegationState, candidateGroups, candidateGroupsExpression, withCandidateGroups, withoutCandidateGroups, withCandidateUsers, withoutCandidateUsers, active, suspended, taskVariables, processVariables, caseInstanceVariables, variableNamesIgnoreCase, variableValuesIgnoreCase, parentTaskId, sortBy, sortOrder, firstResult, maxResults, Collections.emptyMap());
}
/**
* Get List
* Queries for tasks that fulfill a given filter. The size of the result set can be retrieved by using the Get Task Count method. **Security Consideration:** There are several query parameters (such as assigneeExpression) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on [security considerations](https://docs.camunda.org/manual/7.21/user-guide/process-engine/securing-custom-code/) for custom code in the user guide for details.
* @param taskId Restrict to task with the given id. (optional)
* @param taskIdIn Restrict to tasks with any of the given ids. (optional)
* @param processInstanceId Restrict to tasks that belong to process instances with the given id. (optional)
* @param processInstanceIdIn Restrict to tasks that belong to process instances with the given ids. (optional)
* @param processInstanceBusinessKey Restrict to tasks that belong to process instances with the given business key. (optional)
* @param processInstanceBusinessKeyExpression Restrict to tasks that belong to process instances with the given business key which is described by an expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param processInstanceBusinessKeyIn Restrict to tasks that belong to process instances with one of the give business keys. The keys need to be in a comma-separated list. (optional)
* @param processInstanceBusinessKeyLike Restrict to tasks that have a process instance business key that has the parameter value as a substring. (optional)
* @param processInstanceBusinessKeyLikeExpression Restrict to tasks that have a process instance business key that has the parameter value as a substring and is described by an expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param processDefinitionId Restrict to tasks that belong to a process definition with the given id. (optional)
* @param processDefinitionKey Restrict to tasks that belong to a process definition with the given key. (optional)
* @param processDefinitionKeyIn Restrict to tasks that belong to a process definition with one of the given keys. The keys need to be in a comma-separated list. (optional)
* @param processDefinitionName Restrict to tasks that belong to a process definition with the given name. (optional)
* @param processDefinitionNameLike Restrict to tasks that have a process definition name that has the parameter value as a substring. (optional)
* @param executionId Restrict to tasks that belong to an execution with the given id. (optional)
* @param caseInstanceId Restrict to tasks that belong to case instances with the given id. (optional)
* @param caseInstanceBusinessKey Restrict to tasks that belong to case instances with the given business key. (optional)
* @param caseInstanceBusinessKeyLike Restrict to tasks that have a case instance business key that has the parameter value as a substring. (optional)
* @param caseDefinitionId Restrict to tasks that belong to a case definition with the given id. (optional)
* @param caseDefinitionKey Restrict to tasks that belong to a case definition with the given key. (optional)
* @param caseDefinitionName Restrict to tasks that belong to a case definition with the given name. (optional)
* @param caseDefinitionNameLike Restrict to tasks that have a case definition name that has the parameter value as a substring. (optional)
* @param caseExecutionId Restrict to tasks that belong to a case execution with the given id. (optional)
* @param activityInstanceIdIn Only include tasks which belong to one of the passed and comma-separated activity instance ids. (optional)
* @param tenantIdIn Only include tasks which belong to one of the passed and comma-separated tenant ids. (optional)
* @param withoutTenantId Only include tasks which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param assignee Restrict to tasks that the given user is assigned to. (optional)
* @param assigneeExpression Restrict to tasks that the user described by the given expression is assigned to. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param assigneeLike Restrict to tasks that have an assignee that has the parameter value as a substring. (optional)
* @param assigneeLikeExpression Restrict to tasks that have an assignee that has the parameter value described by the given expression as a substring. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param assigneeIn Only include tasks which are assigned to one of the passed and comma-separated user ids. (optional)
* @param assigneeNotIn Only include tasks which are not assigned to one of the passed and comma-separated user ids. (optional)
* @param owner Restrict to tasks that the given user owns. (optional)
* @param ownerExpression Restrict to tasks that the user described by the given expression owns. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param candidateGroup Only include tasks that are offered to the given group. (optional)
* @param candidateGroupExpression Only include tasks that are offered to the group described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param candidateUser Only include tasks that are offered to the given user or to one of his groups. (optional)
* @param candidateUserExpression Only include tasks that are offered to the user described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param includeAssignedTasks Also include tasks that are assigned to users in candidate queries. Default is to only include tasks that are not assigned to any user if you query by candidate user or group(s). (optional, default to false)
* @param involvedUser Only include tasks that the given user is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee). (optional)
* @param involvedUserExpression Only include tasks that the user described by the given expression is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee). See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param assigned If set to `true`, restricts the query to all tasks that are assigned. (optional, default to false)
* @param unassigned If set to `true`, restricts the query to all tasks that are unassigned. (optional, default to false)
* @param taskDefinitionKey Restrict to tasks that have the given key. (optional)
* @param taskDefinitionKeyIn Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list. (optional)
* @param taskDefinitionKeyLike Restrict to tasks that have a key that has the parameter value as a substring. (optional)
* @param name Restrict to tasks that have the given name. (optional)
* @param nameNotEqual Restrict to tasks that do not have the given name. (optional)
* @param nameLike Restrict to tasks that have a name with the given parameter value as substring. (optional)
* @param nameNotLike Restrict to tasks that do not have a name with the given parameter value as substring. (optional)
* @param description Restrict to tasks that have the given description. (optional)
* @param descriptionLike Restrict to tasks that have a description that has the parameter value as a substring. (optional)
* @param priority Restrict to tasks that have the given priority. (optional)
* @param maxPriority Restrict to tasks that have a lower or equal priority. (optional)
* @param minPriority Restrict to tasks that have a higher or equal priority. (optional)
* @param dueDate Restrict to tasks that are due on the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.546+0200`. (optional)
* @param dueDateExpression Restrict to tasks that are due on the date described by the given expression. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param dueAfter Restrict to tasks that are due after the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.435+0200`. (optional)
* @param dueAfterExpression Restrict to tasks that are due after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param dueBefore Restrict to tasks that are due before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.243+0200`. (optional)
* @param dueBeforeExpression Restrict to tasks that are due before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param withoutDueDate Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param followUpDate Restrict to tasks that have a followUp date on the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.342+0200`. (optional)
* @param followUpDateExpression Restrict to tasks that have a followUp date on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param followUpAfter Restrict to tasks that have a followUp date after the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.542+0200`. (optional)
* @param followUpAfterExpression Restrict to tasks that have a followUp date after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param followUpBefore Restrict to tasks that have a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.234+0200`. (optional)
* @param followUpBeforeExpression Restrict to tasks that have a followUp date before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param followUpBeforeOrNotExistent Restrict to tasks that have no followUp date or a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.432+0200`. The typical use case is to query all `active` tasks for a user for a given date. (optional)
* @param followUpBeforeOrNotExistentExpression Restrict to tasks that have no followUp date or a followUp date before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param createdOn Restrict to tasks that were created on the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.324+0200`. (optional)
* @param createdOnExpression Restrict to tasks that were created on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param createdAfter Restrict to tasks that were created after the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.342+0200`. (optional)
* @param createdAfterExpression Restrict to tasks that were created after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param createdBefore Restrict to tasks that were created before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.332+0200`. (optional)
* @param createdBeforeExpression Restrict to tasks that were created before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param updatedAfter Restrict to tasks that were updated after the given date. Every action that fires a [task update event](https://docs.camunda.org/manual/7.21/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.332+0200`. (optional)
* @param updatedAfterExpression Restrict to tasks that were updated after the date described by the given expression. Every action that fires a [task update event](https://docs.camunda.org/manual/7.21/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param delegationState Restrict to tasks that are in the given delegation state. Valid values are `PENDING` and `RESOLVED`. (optional)
* @param candidateGroups Restrict to tasks that are offered to any of the given candidate groups. Takes a comma-separated list of group names, so for example `developers,support,sales`. (optional)
* @param candidateGroupsExpression Restrict to tasks that are offered to any of the candidate groups described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to `java.util.List` of Strings. (optional)
* @param withCandidateGroups Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param withoutCandidateGroups Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param withCandidateUsers Only include tasks which have a candidate user. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param withoutCandidateUsers Only include tasks which have no candidate users. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param active Only include active tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param suspended Only include suspended tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param taskVariables Only include tasks 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 processVariables Only include tasks that belong to 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`; `notLike`. `key` and `value` may not contain underscore or comma characters. (optional)
* @param caseInstanceVariables Only include tasks that belong to case 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 `variableName` and `variablename` are treated as equal. (optional, default to false)
* @param variableValuesIgnoreCase Match all variable values in this query case-insensitively. If set `variableValue` and `variablevalue` are treated as equal. (optional, default to false)
* @param parentTaskId Restrict query to all tasks that are sub tasks of the given task. Takes a task id. (optional)
* @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 additionalHeaders additionalHeaders for this call
* @return List<TaskDto>
* @throws ApiException if fails to make API call
*/
public List getTasks(String taskId, String taskIdIn, String processInstanceId, String processInstanceIdIn, String processInstanceBusinessKey, String processInstanceBusinessKeyExpression, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String processInstanceBusinessKeyLikeExpression, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionName, String processDefinitionNameLike, String executionId, String caseInstanceId, String caseInstanceBusinessKey, String caseInstanceBusinessKeyLike, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String caseDefinitionNameLike, String caseExecutionId, String activityInstanceIdIn, String tenantIdIn, Boolean withoutTenantId, String assignee, String assigneeExpression, String assigneeLike, String assigneeLikeExpression, String assigneeIn, String assigneeNotIn, String owner, String ownerExpression, String candidateGroup, String candidateGroupExpression, String candidateUser, String candidateUserExpression, Boolean includeAssignedTasks, String involvedUser, String involvedUserExpression, Boolean assigned, Boolean unassigned, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDefinitionKeyLike, String name, String nameNotEqual, String nameLike, String nameNotLike, String description, String descriptionLike, Integer priority, Integer maxPriority, Integer minPriority, String dueDate, String dueDateExpression, String dueAfter, String dueAfterExpression, String dueBefore, String dueBeforeExpression, Boolean withoutDueDate, String followUpDate, String followUpDateExpression, String followUpAfter, String followUpAfterExpression, String followUpBefore, String followUpBeforeExpression, String followUpBeforeOrNotExistent, String followUpBeforeOrNotExistentExpression, String createdOn, String createdOnExpression, String createdAfter, String createdAfterExpression, String createdBefore, String createdBeforeExpression, String updatedAfter, String updatedAfterExpression, String delegationState, String candidateGroups, String candidateGroupsExpression, Boolean withCandidateGroups, Boolean withoutCandidateGroups, Boolean withCandidateUsers, Boolean withoutCandidateUsers, Boolean active, Boolean suspended, String taskVariables, String processVariables, String caseInstanceVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String parentTaskId, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/task";
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("taskId", taskId));
localVarQueryParams.addAll(apiClient.parameterToPair("taskIdIn", taskIdIn));
localVarQueryParams.addAll(apiClient.parameterToPair("processInstanceId", processInstanceId));
localVarQueryParams.addAll(apiClient.parameterToPair("processInstanceIdIn", processInstanceIdIn));
localVarQueryParams.addAll(apiClient.parameterToPair("processInstanceBusinessKey", processInstanceBusinessKey));
localVarQueryParams.addAll(apiClient.parameterToPair("processInstanceBusinessKeyExpression", processInstanceBusinessKeyExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("processInstanceBusinessKeyIn", processInstanceBusinessKeyIn));
localVarQueryParams.addAll(apiClient.parameterToPair("processInstanceBusinessKeyLike", processInstanceBusinessKeyLike));
localVarQueryParams.addAll(apiClient.parameterToPair("processInstanceBusinessKeyLikeExpression", processInstanceBusinessKeyLikeExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionId", processDefinitionId));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionKey", processDefinitionKey));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionKeyIn", processDefinitionKeyIn));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionName", processDefinitionName));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionNameLike", processDefinitionNameLike));
localVarQueryParams.addAll(apiClient.parameterToPair("executionId", executionId));
localVarQueryParams.addAll(apiClient.parameterToPair("caseInstanceId", caseInstanceId));
localVarQueryParams.addAll(apiClient.parameterToPair("caseInstanceBusinessKey", caseInstanceBusinessKey));
localVarQueryParams.addAll(apiClient.parameterToPair("caseInstanceBusinessKeyLike", caseInstanceBusinessKeyLike));
localVarQueryParams.addAll(apiClient.parameterToPair("caseDefinitionId", caseDefinitionId));
localVarQueryParams.addAll(apiClient.parameterToPair("caseDefinitionKey", caseDefinitionKey));
localVarQueryParams.addAll(apiClient.parameterToPair("caseDefinitionName", caseDefinitionName));
localVarQueryParams.addAll(apiClient.parameterToPair("caseDefinitionNameLike", caseDefinitionNameLike));
localVarQueryParams.addAll(apiClient.parameterToPair("caseExecutionId", caseExecutionId));
localVarQueryParams.addAll(apiClient.parameterToPair("activityInstanceIdIn", activityInstanceIdIn));
localVarQueryParams.addAll(apiClient.parameterToPair("tenantIdIn", tenantIdIn));
localVarQueryParams.addAll(apiClient.parameterToPair("withoutTenantId", withoutTenantId));
localVarQueryParams.addAll(apiClient.parameterToPair("assignee", assignee));
localVarQueryParams.addAll(apiClient.parameterToPair("assigneeExpression", assigneeExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("assigneeLike", assigneeLike));
localVarQueryParams.addAll(apiClient.parameterToPair("assigneeLikeExpression", assigneeLikeExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("assigneeIn", assigneeIn));
localVarQueryParams.addAll(apiClient.parameterToPair("assigneeNotIn", assigneeNotIn));
localVarQueryParams.addAll(apiClient.parameterToPair("owner", owner));
localVarQueryParams.addAll(apiClient.parameterToPair("ownerExpression", ownerExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("candidateGroup", candidateGroup));
localVarQueryParams.addAll(apiClient.parameterToPair("candidateGroupExpression", candidateGroupExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("candidateUser", candidateUser));
localVarQueryParams.addAll(apiClient.parameterToPair("candidateUserExpression", candidateUserExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("includeAssignedTasks", includeAssignedTasks));
localVarQueryParams.addAll(apiClient.parameterToPair("involvedUser", involvedUser));
localVarQueryParams.addAll(apiClient.parameterToPair("involvedUserExpression", involvedUserExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("assigned", assigned));
localVarQueryParams.addAll(apiClient.parameterToPair("unassigned", unassigned));
localVarQueryParams.addAll(apiClient.parameterToPair("taskDefinitionKey", taskDefinitionKey));
localVarQueryParams.addAll(apiClient.parameterToPair("taskDefinitionKeyIn", taskDefinitionKeyIn));
localVarQueryParams.addAll(apiClient.parameterToPair("taskDefinitionKeyLike", taskDefinitionKeyLike));
localVarQueryParams.addAll(apiClient.parameterToPair("name", name));
localVarQueryParams.addAll(apiClient.parameterToPair("nameNotEqual", nameNotEqual));
localVarQueryParams.addAll(apiClient.parameterToPair("nameLike", nameLike));
localVarQueryParams.addAll(apiClient.parameterToPair("nameNotLike", nameNotLike));
localVarQueryParams.addAll(apiClient.parameterToPair("description", description));
localVarQueryParams.addAll(apiClient.parameterToPair("descriptionLike", descriptionLike));
localVarQueryParams.addAll(apiClient.parameterToPair("priority", priority));
localVarQueryParams.addAll(apiClient.parameterToPair("maxPriority", maxPriority));
localVarQueryParams.addAll(apiClient.parameterToPair("minPriority", minPriority));
localVarQueryParams.addAll(apiClient.parameterToPair("dueDate", dueDate));
localVarQueryParams.addAll(apiClient.parameterToPair("dueDateExpression", dueDateExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("dueAfter", dueAfter));
localVarQueryParams.addAll(apiClient.parameterToPair("dueAfterExpression", dueAfterExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("dueBefore", dueBefore));
localVarQueryParams.addAll(apiClient.parameterToPair("dueBeforeExpression", dueBeforeExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("withoutDueDate", withoutDueDate));
localVarQueryParams.addAll(apiClient.parameterToPair("followUpDate", followUpDate));
localVarQueryParams.addAll(apiClient.parameterToPair("followUpDateExpression", followUpDateExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("followUpAfter", followUpAfter));
localVarQueryParams.addAll(apiClient.parameterToPair("followUpAfterExpression", followUpAfterExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("followUpBefore", followUpBefore));
localVarQueryParams.addAll(apiClient.parameterToPair("followUpBeforeExpression", followUpBeforeExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("followUpBeforeOrNotExistent", followUpBeforeOrNotExistent));
localVarQueryParams.addAll(apiClient.parameterToPair("followUpBeforeOrNotExistentExpression", followUpBeforeOrNotExistentExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("createdOn", createdOn));
localVarQueryParams.addAll(apiClient.parameterToPair("createdOnExpression", createdOnExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("createdAfter", createdAfter));
localVarQueryParams.addAll(apiClient.parameterToPair("createdAfterExpression", createdAfterExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("createdBefore", createdBefore));
localVarQueryParams.addAll(apiClient.parameterToPair("createdBeforeExpression", createdBeforeExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("updatedAfter", updatedAfter));
localVarQueryParams.addAll(apiClient.parameterToPair("updatedAfterExpression", updatedAfterExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("delegationState", delegationState));
localVarQueryParams.addAll(apiClient.parameterToPair("candidateGroups", candidateGroups));
localVarQueryParams.addAll(apiClient.parameterToPair("candidateGroupsExpression", candidateGroupsExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("withCandidateGroups", withCandidateGroups));
localVarQueryParams.addAll(apiClient.parameterToPair("withoutCandidateGroups", withoutCandidateGroups));
localVarQueryParams.addAll(apiClient.parameterToPair("withCandidateUsers", withCandidateUsers));
localVarQueryParams.addAll(apiClient.parameterToPair("withoutCandidateUsers", withoutCandidateUsers));
localVarQueryParams.addAll(apiClient.parameterToPair("active", active));
localVarQueryParams.addAll(apiClient.parameterToPair("suspended", suspended));
localVarQueryParams.addAll(apiClient.parameterToPair("taskVariables", taskVariables));
localVarQueryParams.addAll(apiClient.parameterToPair("processVariables", processVariables));
localVarQueryParams.addAll(apiClient.parameterToPair("caseInstanceVariables", caseInstanceVariables));
localVarQueryParams.addAll(apiClient.parameterToPair("variableNamesIgnoreCase", variableNamesIgnoreCase));
localVarQueryParams.addAll(apiClient.parameterToPair("variableValuesIgnoreCase", variableValuesIgnoreCase));
localVarQueryParams.addAll(apiClient.parameterToPair("parentTaskId", parentTaskId));
localVarQueryParams.addAll(apiClient.parameterToPair("sortBy", sortBy));
localVarQueryParams.addAll(apiClient.parameterToPair("sortOrder", sortOrder));
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 = {
};
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
* Retrieves the number of tasks that fulfill a provided filter. Corresponds to the size of the result set when using the [Get Tasks](https://docs.camunda.org/manual/7.21/reference/rest/task/) method. **Security Consideration:** There are several query parameters (such as assigneeExpression) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on [security considerations](https://docs.camunda.org/manual/7.21/user-guide/process-engine/securing-custom-code/) for custom code in the user guide for details.
* @param taskId Restrict to task with the given id. (optional)
* @param taskIdIn Restrict to tasks with any of the given ids. (optional)
* @param processInstanceId Restrict to tasks that belong to process instances with the given id. (optional)
* @param processInstanceIdIn Restrict to tasks that belong to process instances with the given ids. (optional)
* @param processInstanceBusinessKey Restrict to tasks that belong to process instances with the given business key. (optional)
* @param processInstanceBusinessKeyExpression Restrict to tasks that belong to process instances with the given business key which is described by an expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param processInstanceBusinessKeyIn Restrict to tasks that belong to process instances with one of the give business keys. The keys need to be in a comma-separated list. (optional)
* @param processInstanceBusinessKeyLike Restrict to tasks that have a process instance business key that has the parameter value as a substring. (optional)
* @param processInstanceBusinessKeyLikeExpression Restrict to tasks that have a process instance business key that has the parameter value as a substring and is described by an expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param processDefinitionId Restrict to tasks that belong to a process definition with the given id. (optional)
* @param processDefinitionKey Restrict to tasks that belong to a process definition with the given key. (optional)
* @param processDefinitionKeyIn Restrict to tasks that belong to a process definition with one of the given keys. The keys need to be in a comma-separated list. (optional)
* @param processDefinitionName Restrict to tasks that belong to a process definition with the given name. (optional)
* @param processDefinitionNameLike Restrict to tasks that have a process definition name that has the parameter value as a substring. (optional)
* @param executionId Restrict to tasks that belong to an execution with the given id. (optional)
* @param caseInstanceId Restrict to tasks that belong to case instances with the given id. (optional)
* @param caseInstanceBusinessKey Restrict to tasks that belong to case instances with the given business key. (optional)
* @param caseInstanceBusinessKeyLike Restrict to tasks that have a case instance business key that has the parameter value as a substring. (optional)
* @param caseDefinitionId Restrict to tasks that belong to a case definition with the given id. (optional)
* @param caseDefinitionKey Restrict to tasks that belong to a case definition with the given key. (optional)
* @param caseDefinitionName Restrict to tasks that belong to a case definition with the given name. (optional)
* @param caseDefinitionNameLike Restrict to tasks that have a case definition name that has the parameter value as a substring. (optional)
* @param caseExecutionId Restrict to tasks that belong to a case execution with the given id. (optional)
* @param activityInstanceIdIn Only include tasks which belong to one of the passed and comma-separated activity instance ids. (optional)
* @param tenantIdIn Only include tasks which belong to one of the passed and comma-separated tenant ids. (optional)
* @param withoutTenantId Only include tasks which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param assignee Restrict to tasks that the given user is assigned to. (optional)
* @param assigneeExpression Restrict to tasks that the user described by the given expression is assigned to. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param assigneeLike Restrict to tasks that have an assignee that has the parameter value as a substring. (optional)
* @param assigneeLikeExpression Restrict to tasks that have an assignee that has the parameter value described by the given expression as a substring. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param assigneeIn Only include tasks which are assigned to one of the passed and comma-separated user ids. (optional)
* @param assigneeNotIn Only include tasks which are not assigned to one of the passed and comma-separated user ids. (optional)
* @param owner Restrict to tasks that the given user owns. (optional)
* @param ownerExpression Restrict to tasks that the user described by the given expression owns. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param candidateGroup Only include tasks that are offered to the given group. (optional)
* @param candidateGroupExpression Only include tasks that are offered to the group described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param candidateUser Only include tasks that are offered to the given user or to one of his groups. (optional)
* @param candidateUserExpression Only include tasks that are offered to the user described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param includeAssignedTasks Also include tasks that are assigned to users in candidate queries. Default is to only include tasks that are not assigned to any user if you query by candidate user or group(s). (optional, default to false)
* @param involvedUser Only include tasks that the given user is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee). (optional)
* @param involvedUserExpression Only include tasks that the user described by the given expression is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee). See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param assigned If set to `true`, restricts the query to all tasks that are assigned. (optional, default to false)
* @param unassigned If set to `true`, restricts the query to all tasks that are unassigned. (optional, default to false)
* @param taskDefinitionKey Restrict to tasks that have the given key. (optional)
* @param taskDefinitionKeyIn Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list. (optional)
* @param taskDefinitionKeyLike Restrict to tasks that have a key that has the parameter value as a substring. (optional)
* @param name Restrict to tasks that have the given name. (optional)
* @param nameNotEqual Restrict to tasks that do not have the given name. (optional)
* @param nameLike Restrict to tasks that have a name with the given parameter value as substring. (optional)
* @param nameNotLike Restrict to tasks that do not have a name with the given parameter value as substring. (optional)
* @param description Restrict to tasks that have the given description. (optional)
* @param descriptionLike Restrict to tasks that have a description that has the parameter value as a substring. (optional)
* @param priority Restrict to tasks that have the given priority. (optional)
* @param maxPriority Restrict to tasks that have a lower or equal priority. (optional)
* @param minPriority Restrict to tasks that have a higher or equal priority. (optional)
* @param dueDate Restrict to tasks that are due on the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.546+0200`. (optional)
* @param dueDateExpression Restrict to tasks that are due on the date described by the given expression. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param dueAfter Restrict to tasks that are due after the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.435+0200`. (optional)
* @param dueAfterExpression Restrict to tasks that are due after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param dueBefore Restrict to tasks that are due before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.243+0200`. (optional)
* @param dueBeforeExpression Restrict to tasks that are due before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param withoutDueDate Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param followUpDate Restrict to tasks that have a followUp date on the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.342+0200`. (optional)
* @param followUpDateExpression Restrict to tasks that have a followUp date on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param followUpAfter Restrict to tasks that have a followUp date after the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.542+0200`. (optional)
* @param followUpAfterExpression Restrict to tasks that have a followUp date after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param followUpBefore Restrict to tasks that have a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.234+0200`. (optional)
* @param followUpBeforeExpression Restrict to tasks that have a followUp date before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param followUpBeforeOrNotExistent Restrict to tasks that have no followUp date or a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.432+0200`. The typical use case is to query all `active` tasks for a user for a given date. (optional)
* @param followUpBeforeOrNotExistentExpression Restrict to tasks that have no followUp date or a followUp date before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param createdOn Restrict to tasks that were created on the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.324+0200`. (optional)
* @param createdOnExpression Restrict to tasks that were created on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param createdAfter Restrict to tasks that were created after the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.342+0200`. (optional)
* @param createdAfterExpression Restrict to tasks that were created after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param createdBefore Restrict to tasks that were created before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.332+0200`. (optional)
* @param createdBeforeExpression Restrict to tasks that were created before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param updatedAfter Restrict to tasks that were updated after the given date. Every action that fires a [task update event](https://docs.camunda.org/manual/7.21/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.332+0200`. (optional)
* @param updatedAfterExpression Restrict to tasks that were updated after the date described by the given expression. Every action that fires a [task update event](https://docs.camunda.org/manual/7.21/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param delegationState Restrict to tasks that are in the given delegation state. Valid values are `PENDING` and `RESOLVED`. (optional)
* @param candidateGroups Restrict to tasks that are offered to any of the given candidate groups. Takes a comma-separated list of group names, so for example `developers,support,sales`. (optional)
* @param candidateGroupsExpression Restrict to tasks that are offered to any of the candidate groups described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to `java.util.List` of Strings. (optional)
* @param withCandidateGroups Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param withoutCandidateGroups Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param withCandidateUsers Only include tasks which have a candidate user. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param withoutCandidateUsers Only include tasks which have no candidate users. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param active Only include active tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param suspended Only include suspended tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param taskVariables Only include tasks 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 processVariables Only include tasks that belong to 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`; `notLike`. `key` and `value` may not contain underscore or comma characters. (optional)
* @param caseInstanceVariables Only include tasks that belong to case 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 `variableName` and `variablename` are treated as equal. (optional, default to false)
* @param variableValuesIgnoreCase Match all variable values in this query case-insensitively. If set `variableValue` and `variablevalue` are treated as equal. (optional, default to false)
* @param parentTaskId Restrict query to all tasks that are sub tasks of the given task. Takes a task id. (optional)
* @return CountResultDto
* @throws ApiException if fails to make API call
*/
public CountResultDto getTasksCount(String taskId, String taskIdIn, String processInstanceId, String processInstanceIdIn, String processInstanceBusinessKey, String processInstanceBusinessKeyExpression, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String processInstanceBusinessKeyLikeExpression, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionName, String processDefinitionNameLike, String executionId, String caseInstanceId, String caseInstanceBusinessKey, String caseInstanceBusinessKeyLike, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String caseDefinitionNameLike, String caseExecutionId, String activityInstanceIdIn, String tenantIdIn, Boolean withoutTenantId, String assignee, String assigneeExpression, String assigneeLike, String assigneeLikeExpression, String assigneeIn, String assigneeNotIn, String owner, String ownerExpression, String candidateGroup, String candidateGroupExpression, String candidateUser, String candidateUserExpression, Boolean includeAssignedTasks, String involvedUser, String involvedUserExpression, Boolean assigned, Boolean unassigned, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDefinitionKeyLike, String name, String nameNotEqual, String nameLike, String nameNotLike, String description, String descriptionLike, Integer priority, Integer maxPriority, Integer minPriority, String dueDate, String dueDateExpression, String dueAfter, String dueAfterExpression, String dueBefore, String dueBeforeExpression, Boolean withoutDueDate, String followUpDate, String followUpDateExpression, String followUpAfter, String followUpAfterExpression, String followUpBefore, String followUpBeforeExpression, String followUpBeforeOrNotExistent, String followUpBeforeOrNotExistentExpression, String createdOn, String createdOnExpression, String createdAfter, String createdAfterExpression, String createdBefore, String createdBeforeExpression, String updatedAfter, String updatedAfterExpression, String delegationState, String candidateGroups, String candidateGroupsExpression, Boolean withCandidateGroups, Boolean withoutCandidateGroups, Boolean withCandidateUsers, Boolean withoutCandidateUsers, Boolean active, Boolean suspended, String taskVariables, String processVariables, String caseInstanceVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String parentTaskId) throws ApiException {
return this.getTasksCount(taskId, taskIdIn, processInstanceId, processInstanceIdIn, processInstanceBusinessKey, processInstanceBusinessKeyExpression, processInstanceBusinessKeyIn, processInstanceBusinessKeyLike, processInstanceBusinessKeyLikeExpression, processDefinitionId, processDefinitionKey, processDefinitionKeyIn, processDefinitionName, processDefinitionNameLike, executionId, caseInstanceId, caseInstanceBusinessKey, caseInstanceBusinessKeyLike, caseDefinitionId, caseDefinitionKey, caseDefinitionName, caseDefinitionNameLike, caseExecutionId, activityInstanceIdIn, tenantIdIn, withoutTenantId, assignee, assigneeExpression, assigneeLike, assigneeLikeExpression, assigneeIn, assigneeNotIn, owner, ownerExpression, candidateGroup, candidateGroupExpression, candidateUser, candidateUserExpression, includeAssignedTasks, involvedUser, involvedUserExpression, assigned, unassigned, taskDefinitionKey, taskDefinitionKeyIn, taskDefinitionKeyLike, name, nameNotEqual, nameLike, nameNotLike, description, descriptionLike, priority, maxPriority, minPriority, dueDate, dueDateExpression, dueAfter, dueAfterExpression, dueBefore, dueBeforeExpression, withoutDueDate, followUpDate, followUpDateExpression, followUpAfter, followUpAfterExpression, followUpBefore, followUpBeforeExpression, followUpBeforeOrNotExistent, followUpBeforeOrNotExistentExpression, createdOn, createdOnExpression, createdAfter, createdAfterExpression, createdBefore, createdBeforeExpression, updatedAfter, updatedAfterExpression, delegationState, candidateGroups, candidateGroupsExpression, withCandidateGroups, withoutCandidateGroups, withCandidateUsers, withoutCandidateUsers, active, suspended, taskVariables, processVariables, caseInstanceVariables, variableNamesIgnoreCase, variableValuesIgnoreCase, parentTaskId, Collections.emptyMap());
}
/**
* Get List Count
* Retrieves the number of tasks that fulfill a provided filter. Corresponds to the size of the result set when using the [Get Tasks](https://docs.camunda.org/manual/7.21/reference/rest/task/) method. **Security Consideration:** There are several query parameters (such as assigneeExpression) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on [security considerations](https://docs.camunda.org/manual/7.21/user-guide/process-engine/securing-custom-code/) for custom code in the user guide for details.
* @param taskId Restrict to task with the given id. (optional)
* @param taskIdIn Restrict to tasks with any of the given ids. (optional)
* @param processInstanceId Restrict to tasks that belong to process instances with the given id. (optional)
* @param processInstanceIdIn Restrict to tasks that belong to process instances with the given ids. (optional)
* @param processInstanceBusinessKey Restrict to tasks that belong to process instances with the given business key. (optional)
* @param processInstanceBusinessKeyExpression Restrict to tasks that belong to process instances with the given business key which is described by an expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param processInstanceBusinessKeyIn Restrict to tasks that belong to process instances with one of the give business keys. The keys need to be in a comma-separated list. (optional)
* @param processInstanceBusinessKeyLike Restrict to tasks that have a process instance business key that has the parameter value as a substring. (optional)
* @param processInstanceBusinessKeyLikeExpression Restrict to tasks that have a process instance business key that has the parameter value as a substring and is described by an expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param processDefinitionId Restrict to tasks that belong to a process definition with the given id. (optional)
* @param processDefinitionKey Restrict to tasks that belong to a process definition with the given key. (optional)
* @param processDefinitionKeyIn Restrict to tasks that belong to a process definition with one of the given keys. The keys need to be in a comma-separated list. (optional)
* @param processDefinitionName Restrict to tasks that belong to a process definition with the given name. (optional)
* @param processDefinitionNameLike Restrict to tasks that have a process definition name that has the parameter value as a substring. (optional)
* @param executionId Restrict to tasks that belong to an execution with the given id. (optional)
* @param caseInstanceId Restrict to tasks that belong to case instances with the given id. (optional)
* @param caseInstanceBusinessKey Restrict to tasks that belong to case instances with the given business key. (optional)
* @param caseInstanceBusinessKeyLike Restrict to tasks that have a case instance business key that has the parameter value as a substring. (optional)
* @param caseDefinitionId Restrict to tasks that belong to a case definition with the given id. (optional)
* @param caseDefinitionKey Restrict to tasks that belong to a case definition with the given key. (optional)
* @param caseDefinitionName Restrict to tasks that belong to a case definition with the given name. (optional)
* @param caseDefinitionNameLike Restrict to tasks that have a case definition name that has the parameter value as a substring. (optional)
* @param caseExecutionId Restrict to tasks that belong to a case execution with the given id. (optional)
* @param activityInstanceIdIn Only include tasks which belong to one of the passed and comma-separated activity instance ids. (optional)
* @param tenantIdIn Only include tasks which belong to one of the passed and comma-separated tenant ids. (optional)
* @param withoutTenantId Only include tasks which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param assignee Restrict to tasks that the given user is assigned to. (optional)
* @param assigneeExpression Restrict to tasks that the user described by the given expression is assigned to. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param assigneeLike Restrict to tasks that have an assignee that has the parameter value as a substring. (optional)
* @param assigneeLikeExpression Restrict to tasks that have an assignee that has the parameter value described by the given expression as a substring. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param assigneeIn Only include tasks which are assigned to one of the passed and comma-separated user ids. (optional)
* @param assigneeNotIn Only include tasks which are not assigned to one of the passed and comma-separated user ids. (optional)
* @param owner Restrict to tasks that the given user owns. (optional)
* @param ownerExpression Restrict to tasks that the user described by the given expression owns. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param candidateGroup Only include tasks that are offered to the given group. (optional)
* @param candidateGroupExpression Only include tasks that are offered to the group described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param candidateUser Only include tasks that are offered to the given user or to one of his groups. (optional)
* @param candidateUserExpression Only include tasks that are offered to the user described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param includeAssignedTasks Also include tasks that are assigned to users in candidate queries. Default is to only include tasks that are not assigned to any user if you query by candidate user or group(s). (optional, default to false)
* @param involvedUser Only include tasks that the given user is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee). (optional)
* @param involvedUserExpression Only include tasks that the user described by the given expression is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee). See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)
* @param assigned If set to `true`, restricts the query to all tasks that are assigned. (optional, default to false)
* @param unassigned If set to `true`, restricts the query to all tasks that are unassigned. (optional, default to false)
* @param taskDefinitionKey Restrict to tasks that have the given key. (optional)
* @param taskDefinitionKeyIn Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list. (optional)
* @param taskDefinitionKeyLike Restrict to tasks that have a key that has the parameter value as a substring. (optional)
* @param name Restrict to tasks that have the given name. (optional)
* @param nameNotEqual Restrict to tasks that do not have the given name. (optional)
* @param nameLike Restrict to tasks that have a name with the given parameter value as substring. (optional)
* @param nameNotLike Restrict to tasks that do not have a name with the given parameter value as substring. (optional)
* @param description Restrict to tasks that have the given description. (optional)
* @param descriptionLike Restrict to tasks that have a description that has the parameter value as a substring. (optional)
* @param priority Restrict to tasks that have the given priority. (optional)
* @param maxPriority Restrict to tasks that have a lower or equal priority. (optional)
* @param minPriority Restrict to tasks that have a higher or equal priority. (optional)
* @param dueDate Restrict to tasks that are due on the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.546+0200`. (optional)
* @param dueDateExpression Restrict to tasks that are due on the date described by the given expression. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param dueAfter Restrict to tasks that are due after the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.435+0200`. (optional)
* @param dueAfterExpression Restrict to tasks that are due after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param dueBefore Restrict to tasks that are due before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.243+0200`. (optional)
* @param dueBeforeExpression Restrict to tasks that are due before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param withoutDueDate Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param followUpDate Restrict to tasks that have a followUp date on the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.342+0200`. (optional)
* @param followUpDateExpression Restrict to tasks that have a followUp date on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param followUpAfter Restrict to tasks that have a followUp date after the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.542+0200`. (optional)
* @param followUpAfterExpression Restrict to tasks that have a followUp date after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param followUpBefore Restrict to tasks that have a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.234+0200`. (optional)
* @param followUpBeforeExpression Restrict to tasks that have a followUp date before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param followUpBeforeOrNotExistent Restrict to tasks that have no followUp date or a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.432+0200`. The typical use case is to query all `active` tasks for a user for a given date. (optional)
* @param followUpBeforeOrNotExistentExpression Restrict to tasks that have no followUp date or a followUp date before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param createdOn Restrict to tasks that were created on the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.324+0200`. (optional)
* @param createdOnExpression Restrict to tasks that were created on the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param createdAfter Restrict to tasks that were created after the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.342+0200`. (optional)
* @param createdAfterExpression Restrict to tasks that were created after the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param createdBefore Restrict to tasks that were created before the given date. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.332+0200`. (optional)
* @param createdBeforeExpression Restrict to tasks that were created before the date described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param updatedAfter Restrict to tasks that were updated after the given date. Every action that fires a [task update event](https://docs.camunda.org/manual/7.21/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. By [default](https://docs.camunda.org/manual/7.21/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.332+0200`. (optional)
* @param updatedAfterExpression Restrict to tasks that were updated after the date described by the given expression. Every action that fires a [task update event](https://docs.camunda.org/manual/7.21/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to a `java.util.Date` or `org.joda.time.DateTime` object. (optional)
* @param delegationState Restrict to tasks that are in the given delegation state. Valid values are `PENDING` and `RESOLVED`. (optional)
* @param candidateGroups Restrict to tasks that are offered to any of the given candidate groups. Takes a comma-separated list of group names, so for example `developers,support,sales`. (optional)
* @param candidateGroupsExpression Restrict to tasks that are offered to any of the candidate groups described by the given expression. See the [user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. The expression must evaluate to `java.util.List` of Strings. (optional)
* @param withCandidateGroups Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param withoutCandidateGroups Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param withCandidateUsers Only include tasks which have a candidate user. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param withoutCandidateUsers Only include tasks which have no candidate users. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param active Only include active tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param suspended Only include suspended tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)
* @param taskVariables Only include tasks 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 processVariables Only include tasks that belong to 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`; `notLike`. `key` and `value` may not contain underscore or comma characters. (optional)
* @param caseInstanceVariables Only include tasks that belong to case 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 `variableName` and `variablename` are treated as equal. (optional, default to false)
* @param variableValuesIgnoreCase Match all variable values in this query case-insensitively. If set `variableValue` and `variablevalue` are treated as equal. (optional, default to false)
* @param parentTaskId Restrict query to all tasks that are sub tasks of the given task. Takes a task id. (optional)
* @param additionalHeaders additionalHeaders for this call
* @return CountResultDto
* @throws ApiException if fails to make API call
*/
public CountResultDto getTasksCount(String taskId, String taskIdIn, String processInstanceId, String processInstanceIdIn, String processInstanceBusinessKey, String processInstanceBusinessKeyExpression, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String processInstanceBusinessKeyLikeExpression, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionName, String processDefinitionNameLike, String executionId, String caseInstanceId, String caseInstanceBusinessKey, String caseInstanceBusinessKeyLike, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String caseDefinitionNameLike, String caseExecutionId, String activityInstanceIdIn, String tenantIdIn, Boolean withoutTenantId, String assignee, String assigneeExpression, String assigneeLike, String assigneeLikeExpression, String assigneeIn, String assigneeNotIn, String owner, String ownerExpression, String candidateGroup, String candidateGroupExpression, String candidateUser, String candidateUserExpression, Boolean includeAssignedTasks, String involvedUser, String involvedUserExpression, Boolean assigned, Boolean unassigned, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDefinitionKeyLike, String name, String nameNotEqual, String nameLike, String nameNotLike, String description, String descriptionLike, Integer priority, Integer maxPriority, Integer minPriority, String dueDate, String dueDateExpression, String dueAfter, String dueAfterExpression, String dueBefore, String dueBeforeExpression, Boolean withoutDueDate, String followUpDate, String followUpDateExpression, String followUpAfter, String followUpAfterExpression, String followUpBefore, String followUpBeforeExpression, String followUpBeforeOrNotExistent, String followUpBeforeOrNotExistentExpression, String createdOn, String createdOnExpression, String createdAfter, String createdAfterExpression, String createdBefore, String createdBeforeExpression, String updatedAfter, String updatedAfterExpression, String delegationState, String candidateGroups, String candidateGroupsExpression, Boolean withCandidateGroups, Boolean withoutCandidateGroups, Boolean withCandidateUsers, Boolean withoutCandidateUsers, Boolean active, Boolean suspended, String taskVariables, String processVariables, String caseInstanceVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String parentTaskId, Map additionalHeaders) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/task/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("taskId", taskId));
localVarQueryParams.addAll(apiClient.parameterToPair("taskIdIn", taskIdIn));
localVarQueryParams.addAll(apiClient.parameterToPair("processInstanceId", processInstanceId));
localVarQueryParams.addAll(apiClient.parameterToPair("processInstanceIdIn", processInstanceIdIn));
localVarQueryParams.addAll(apiClient.parameterToPair("processInstanceBusinessKey", processInstanceBusinessKey));
localVarQueryParams.addAll(apiClient.parameterToPair("processInstanceBusinessKeyExpression", processInstanceBusinessKeyExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("processInstanceBusinessKeyIn", processInstanceBusinessKeyIn));
localVarQueryParams.addAll(apiClient.parameterToPair("processInstanceBusinessKeyLike", processInstanceBusinessKeyLike));
localVarQueryParams.addAll(apiClient.parameterToPair("processInstanceBusinessKeyLikeExpression", processInstanceBusinessKeyLikeExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionId", processDefinitionId));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionKey", processDefinitionKey));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionKeyIn", processDefinitionKeyIn));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionName", processDefinitionName));
localVarQueryParams.addAll(apiClient.parameterToPair("processDefinitionNameLike", processDefinitionNameLike));
localVarQueryParams.addAll(apiClient.parameterToPair("executionId", executionId));
localVarQueryParams.addAll(apiClient.parameterToPair("caseInstanceId", caseInstanceId));
localVarQueryParams.addAll(apiClient.parameterToPair("caseInstanceBusinessKey", caseInstanceBusinessKey));
localVarQueryParams.addAll(apiClient.parameterToPair("caseInstanceBusinessKeyLike", caseInstanceBusinessKeyLike));
localVarQueryParams.addAll(apiClient.parameterToPair("caseDefinitionId", caseDefinitionId));
localVarQueryParams.addAll(apiClient.parameterToPair("caseDefinitionKey", caseDefinitionKey));
localVarQueryParams.addAll(apiClient.parameterToPair("caseDefinitionName", caseDefinitionName));
localVarQueryParams.addAll(apiClient.parameterToPair("caseDefinitionNameLike", caseDefinitionNameLike));
localVarQueryParams.addAll(apiClient.parameterToPair("caseExecutionId", caseExecutionId));
localVarQueryParams.addAll(apiClient.parameterToPair("activityInstanceIdIn", activityInstanceIdIn));
localVarQueryParams.addAll(apiClient.parameterToPair("tenantIdIn", tenantIdIn));
localVarQueryParams.addAll(apiClient.parameterToPair("withoutTenantId", withoutTenantId));
localVarQueryParams.addAll(apiClient.parameterToPair("assignee", assignee));
localVarQueryParams.addAll(apiClient.parameterToPair("assigneeExpression", assigneeExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("assigneeLike", assigneeLike));
localVarQueryParams.addAll(apiClient.parameterToPair("assigneeLikeExpression", assigneeLikeExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("assigneeIn", assigneeIn));
localVarQueryParams.addAll(apiClient.parameterToPair("assigneeNotIn", assigneeNotIn));
localVarQueryParams.addAll(apiClient.parameterToPair("owner", owner));
localVarQueryParams.addAll(apiClient.parameterToPair("ownerExpression", ownerExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("candidateGroup", candidateGroup));
localVarQueryParams.addAll(apiClient.parameterToPair("candidateGroupExpression", candidateGroupExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("candidateUser", candidateUser));
localVarQueryParams.addAll(apiClient.parameterToPair("candidateUserExpression", candidateUserExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("includeAssignedTasks", includeAssignedTasks));
localVarQueryParams.addAll(apiClient.parameterToPair("involvedUser", involvedUser));
localVarQueryParams.addAll(apiClient.parameterToPair("involvedUserExpression", involvedUserExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("assigned", assigned));
localVarQueryParams.addAll(apiClient.parameterToPair("unassigned", unassigned));
localVarQueryParams.addAll(apiClient.parameterToPair("taskDefinitionKey", taskDefinitionKey));
localVarQueryParams.addAll(apiClient.parameterToPair("taskDefinitionKeyIn", taskDefinitionKeyIn));
localVarQueryParams.addAll(apiClient.parameterToPair("taskDefinitionKeyLike", taskDefinitionKeyLike));
localVarQueryParams.addAll(apiClient.parameterToPair("name", name));
localVarQueryParams.addAll(apiClient.parameterToPair("nameNotEqual", nameNotEqual));
localVarQueryParams.addAll(apiClient.parameterToPair("nameLike", nameLike));
localVarQueryParams.addAll(apiClient.parameterToPair("nameNotLike", nameNotLike));
localVarQueryParams.addAll(apiClient.parameterToPair("description", description));
localVarQueryParams.addAll(apiClient.parameterToPair("descriptionLike", descriptionLike));
localVarQueryParams.addAll(apiClient.parameterToPair("priority", priority));
localVarQueryParams.addAll(apiClient.parameterToPair("maxPriority", maxPriority));
localVarQueryParams.addAll(apiClient.parameterToPair("minPriority", minPriority));
localVarQueryParams.addAll(apiClient.parameterToPair("dueDate", dueDate));
localVarQueryParams.addAll(apiClient.parameterToPair("dueDateExpression", dueDateExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("dueAfter", dueAfter));
localVarQueryParams.addAll(apiClient.parameterToPair("dueAfterExpression", dueAfterExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("dueBefore", dueBefore));
localVarQueryParams.addAll(apiClient.parameterToPair("dueBeforeExpression", dueBeforeExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("withoutDueDate", withoutDueDate));
localVarQueryParams.addAll(apiClient.parameterToPair("followUpDate", followUpDate));
localVarQueryParams.addAll(apiClient.parameterToPair("followUpDateExpression", followUpDateExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("followUpAfter", followUpAfter));
localVarQueryParams.addAll(apiClient.parameterToPair("followUpAfterExpression", followUpAfterExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("followUpBefore", followUpBefore));
localVarQueryParams.addAll(apiClient.parameterToPair("followUpBeforeExpression", followUpBeforeExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("followUpBeforeOrNotExistent", followUpBeforeOrNotExistent));
localVarQueryParams.addAll(apiClient.parameterToPair("followUpBeforeOrNotExistentExpression", followUpBeforeOrNotExistentExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("createdOn", createdOn));
localVarQueryParams.addAll(apiClient.parameterToPair("createdOnExpression", createdOnExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("createdAfter", createdAfter));
localVarQueryParams.addAll(apiClient.parameterToPair("createdAfterExpression", createdAfterExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("createdBefore", createdBefore));
localVarQueryParams.addAll(apiClient.parameterToPair("createdBeforeExpression", createdBeforeExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("updatedAfter", updatedAfter));
localVarQueryParams.addAll(apiClient.parameterToPair("updatedAfterExpression", updatedAfterExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("delegationState", delegationState));
localVarQueryParams.addAll(apiClient.parameterToPair("candidateGroups", candidateGroups));
localVarQueryParams.addAll(apiClient.parameterToPair("candidateGroupsExpression", candidateGroupsExpression));
localVarQueryParams.addAll(apiClient.parameterToPair("withCandidateGroups", withCandidateGroups));
localVarQueryParams.addAll(apiClient.parameterToPair("withoutCandidateGroups", withoutCandidateGroups));
localVarQueryParams.addAll(apiClient.parameterToPair("withCandidateUsers", withCandidateUsers));
localVarQueryParams.addAll(apiClient.parameterToPair("withoutCandidateUsers", withoutCandidateUsers));
localVarQueryParams.addAll(apiClient.parameterToPair("active", active));
localVarQueryParams.addAll(apiClient.parameterToPair("suspended", suspended));
localVarQueryParams.addAll(apiClient.parameterToPair("taskVariables", taskVariables));
localVarQueryParams.addAll(apiClient.parameterToPair("processVariables", processVariables));
localVarQueryParams.addAll(apiClient.parameterToPair("caseInstanceVariables", caseInstanceVariables));
localVarQueryParams.addAll(apiClient.parameterToPair("variableNamesIgnoreCase", variableNamesIgnoreCase));
localVarQueryParams.addAll(apiClient.parameterToPair("variableValuesIgnoreCase", variableValuesIgnoreCase));
localVarQueryParams.addAll(apiClient.parameterToPair("parentTaskId", parentTaskId));
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
);
}
/**
* Handle BPMN Error
* Reports a business error in the context of a running task by id. The error code must be specified to identify the BPMN error handler. See the documentation for [Reporting Bpmn Error](https://docs.camunda.org/manual/7.21/reference/bpmn20/tasks/user-task/#reporting-bpmn-error) in User Tasks.
* @param id The id of the task a BPMN error is reported for. (required)
* @param taskBpmnErrorDto (optional)
* @throws ApiException if fails to make API call
*/
public void handleBpmnError(String id, TaskBpmnErrorDto taskBpmnErrorDto) throws ApiException {
this.handleBpmnError(id, taskBpmnErrorDto, Collections.emptyMap());
}
/**
* Handle BPMN Error
* Reports a business error in the context of a running task by id. The error code must be specified to identify the BPMN error handler. See the documentation for [Reporting Bpmn Error](https://docs.camunda.org/manual/7.21/reference/bpmn20/tasks/user-task/#reporting-bpmn-error) in User Tasks.
* @param id The id of the task a BPMN error is reported for. (required)
* @param taskBpmnErrorDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void handleBpmnError(String id, TaskBpmnErrorDto taskBpmnErrorDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = taskBpmnErrorDto;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling handleBpmnError");
}
// create path and map variables
String localVarPath = "/task/{id}/bpmnError"
.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
);
}
/**
* Handle BPMN Escalation
* Reports an escalation in the context of a running task by id. The escalation code must be specified to identify the escalation handler. See the documentation for [Reporting Bpmn Escalation](https://docs.camunda.org/manual/7.21/reference/bpmn20/tasks/user-task/#reporting-bpmn-escalation) in User Tasks.
* @param id The id of the task in which context a BPMN escalation is reported. (required)
* @param taskEscalationDto (optional)
* @throws ApiException if fails to make API call
*/
public void handleEscalation(String id, TaskEscalationDto taskEscalationDto) throws ApiException {
this.handleEscalation(id, taskEscalationDto, Collections.emptyMap());
}
/**
* Handle BPMN Escalation
* Reports an escalation in the context of a running task by id. The escalation code must be specified to identify the escalation handler. See the documentation for [Reporting Bpmn Escalation](https://docs.camunda.org/manual/7.21/reference/bpmn20/tasks/user-task/#reporting-bpmn-escalation) in User Tasks.
* @param id The id of the task in which context a BPMN escalation is reported. (required)
* @param taskEscalationDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void handleEscalation(String id, TaskEscalationDto taskEscalationDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = taskEscalationDto;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling handleEscalation");
}
// create path and map variables
String localVarPath = "/task/{id}/bpmnEscalation"
.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 tasks that fulfill a given filter. This method is slightly more powerful than the [Get Tasks](https://docs.camunda.org/manual/7.21/reference/rest/task/get-query/) method because it allows filtering by multiple process or task variables of types `String`, `Number` or `Boolean`. The size of the result set can be retrieved by using the [Get Task Count (POST)](https://docs.camunda.org/manual/7.21/reference/rest/task/post-query-count/) method. **Security Consideration**: There are several parameters (such as `assigneeExpression`) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on [security considerations for custom code](https://docs.camunda.org/manual/7.21/user-guide/process-engine/securing-custom-code/) in the user guide for details.
* @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 taskQueryDto (optional)
* @return List<TaskDto>
* @throws ApiException if fails to make API call
*/
public List queryTasks(Integer firstResult, Integer maxResults, TaskQueryDto taskQueryDto) throws ApiException {
return this.queryTasks(firstResult, maxResults, taskQueryDto, Collections.emptyMap());
}
/**
* Get List (POST)
* Queries for tasks that fulfill a given filter. This method is slightly more powerful than the [Get Tasks](https://docs.camunda.org/manual/7.21/reference/rest/task/get-query/) method because it allows filtering by multiple process or task variables of types `String`, `Number` or `Boolean`. The size of the result set can be retrieved by using the [Get Task Count (POST)](https://docs.camunda.org/manual/7.21/reference/rest/task/post-query-count/) method. **Security Consideration**: There are several parameters (such as `assigneeExpression`) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on [security considerations for custom code](https://docs.camunda.org/manual/7.21/user-guide/process-engine/securing-custom-code/) in the user guide for details.
* @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 taskQueryDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @return List<TaskDto>
* @throws ApiException if fails to make API call
*/
public List queryTasks(Integer firstResult, Integer maxResults, TaskQueryDto taskQueryDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = taskQueryDto;
// create path and map variables
String localVarPath = "/task";
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)
* Retrieves the number of tasks that fulfill the given filter. Corresponds to the size of the result set of the [Get Tasks (POST)](https://docs.camunda.org/manual/7.21/reference/rest/task/post-query/) method and takes the same parameters. **Security Consideration**: There are several parameters (such as `assigneeExpression`) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on [security considerations for custom code](https://docs.camunda.org/manual/7.21/user-guide/process-engine/securing-custom-code/) in the user guide for details.
* @param taskQueryDto (optional)
* @return CountResultDto
* @throws ApiException if fails to make API call
*/
public CountResultDto queryTasksCount(TaskQueryDto taskQueryDto) throws ApiException {
return this.queryTasksCount(taskQueryDto, Collections.emptyMap());
}
/**
* Get List Count (POST)
* Retrieves the number of tasks that fulfill the given filter. Corresponds to the size of the result set of the [Get Tasks (POST)](https://docs.camunda.org/manual/7.21/reference/rest/task/post-query/) method and takes the same parameters. **Security Consideration**: There are several parameters (such as `assigneeExpression`) for specifying an EL expression. These are disabled by default to prevent remote code execution. See the section on [security considerations for custom code](https://docs.camunda.org/manual/7.21/user-guide/process-engine/securing-custom-code/) in the user guide for details.
* @param taskQueryDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @return CountResultDto
* @throws ApiException if fails to make API call
*/
public CountResultDto queryTasksCount(TaskQueryDto taskQueryDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = taskQueryDto;
// create path and map variables
String localVarPath = "/task/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
);
}
/**
* Resolve
* Resolves a task and updates execution variables. Resolving a task marks that the assignee is done with the task delegated to them, and that it can be sent back to the owner. Can only be executed when the task has been delegated. The assignee will be set to the owner, who performed the delegation.
* @param id The id of the task to resolve. (required)
* @param completeTaskDto (optional)
* @throws ApiException if fails to make API call
*/
public void resolve(String id, CompleteTaskDto completeTaskDto) throws ApiException {
this.resolve(id, completeTaskDto, Collections.emptyMap());
}
/**
* Resolve
* Resolves a task and updates execution variables. Resolving a task marks that the assignee is done with the task delegated to them, and that it can be sent back to the owner. Can only be executed when the task has been delegated. The assignee will be set to the owner, who performed the delegation.
* @param id The id of the task to resolve. (required)
* @param completeTaskDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void resolve(String id, CompleteTaskDto completeTaskDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = completeTaskDto;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling resolve");
}
// create path and map variables
String localVarPath = "/task/{id}/resolve"
.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
);
}
/**
* Set Assignee
* Changes the assignee of a task to a specific user. **Note:** The difference with the [Claim Task](https://docs.camunda.org/manual/7.21/reference/rest/task/post-claim/) method is that this method does not check if the task already has a user assigned to it.
* @param id The id of the task to set the assignee for. (required)
* @param userIdDto Provide the id of the user that will be the assignee of the task. (optional)
* @throws ApiException if fails to make API call
*/
public void setAssignee(String id, UserIdDto userIdDto) throws ApiException {
this.setAssignee(id, userIdDto, Collections.emptyMap());
}
/**
* Set Assignee
* Changes the assignee of a task to a specific user. **Note:** The difference with the [Claim Task](https://docs.camunda.org/manual/7.21/reference/rest/task/post-claim/) method is that this method does not check if the task already has a user assigned to it.
* @param id The id of the task to set the assignee for. (required)
* @param userIdDto Provide the id of the user that will be the assignee of the task. (optional)
* @param additionalHeaders additionalHeaders for this call
* @throws ApiException if fails to make API call
*/
public void setAssignee(String id, UserIdDto userIdDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = userIdDto;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling setAssignee");
}
// create path and map variables
String localVarPath = "/task/{id}/assignee"
.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
);
}
/**
* Submit Form
* Completes a task and updates process variables using a form submit. There are two difference between this method and the `complete` method: * If the task is in state `PENDING` - i.e., has been delegated before, it is not completed but resolved. Otherwise it will be completed. * If the task has Form Field Metadata defined, the process engine will perform backend validation for any form fields which have validators defined. See the [Generated Task Forms](https://docs.camunda.org/manual/7.21/user-guide/task-forms/_index/#generated-task-forms) section of the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/) for more information.
* @param id The id of the task to submit the form for. (required)
* @param completeTaskDto (optional)
* @return Map<String, VariableValueDto>
* @throws ApiException if fails to make API call
*/
public Map submit(String id, CompleteTaskDto completeTaskDto) throws ApiException {
return this.submit(id, completeTaskDto, Collections.emptyMap());
}
/**
* Submit Form
* Completes a task and updates process variables using a form submit. There are two difference between this method and the `complete` method: * If the task is in state `PENDING` - i.e., has been delegated before, it is not completed but resolved. Otherwise it will be completed. * If the task has Form Field Metadata defined, the process engine will perform backend validation for any form fields which have validators defined. See the [Generated Task Forms](https://docs.camunda.org/manual/7.21/user-guide/task-forms/_index/#generated-task-forms) section of the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/) for more information.
* @param id The id of the task to submit the form for. (required)
* @param completeTaskDto (optional)
* @param additionalHeaders additionalHeaders for this call
* @return Map<String, VariableValueDto>
* @throws ApiException if fails to make API call
*/
public Map submit(String id, CompleteTaskDto completeTaskDto, Map additionalHeaders) throws ApiException {
Object localVarPostBody = completeTaskDto;
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException(400, "Missing the required parameter 'id' when calling submit");
}
// create path and map variables
String localVarPath = "/task/{id}/submit-form"
.replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()));
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap
