Package org.openapitools.client.api
Class TaskApi
- java.lang.Object
-
- org.openapitools.client.api.TaskApi
-
public class TaskApi extends Object
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclaim(String id, UserIdDto userIdDto)Claim Claims a task for a specific user.okhttp3.CallclaimAsync(String id, UserIdDto userIdDto, ApiCallback<Void> _callback)Claim (asynchronously) Claims a task for a specific user.okhttp3.CallclaimCall(String id, UserIdDto userIdDto, ApiCallback _callback)Build call for claimApiResponse<Void>claimWithHttpInfo(String id, UserIdDto userIdDto)Claim Claims a task for a specific user.Map<String,VariableValueDto>complete(String id, CompleteTaskDto completeTaskDto)Complete Completes a task and updates process variables.okhttp3.CallcompleteAsync(String id, CompleteTaskDto completeTaskDto, ApiCallback<Map<String,VariableValueDto>> _callback)Complete (asynchronously) Completes a task and updates process variables.okhttp3.CallcompleteCall(String id, CompleteTaskDto completeTaskDto, ApiCallback _callback)Build call for completeApiResponse<Map<String,VariableValueDto>>completeWithHttpInfo(String id, CompleteTaskDto completeTaskDto)Complete Completes a task and updates process variables.voidcreateTask(TaskDto taskDto)Create Creates a new task.okhttp3.CallcreateTaskAsync(TaskDto taskDto, ApiCallback<Void> _callback)Create (asynchronously) Creates a new task.okhttp3.CallcreateTaskCall(TaskDto taskDto, ApiCallback _callback)Build call for createTaskApiResponse<Void>createTaskWithHttpInfo(TaskDto taskDto)Create Creates a new task.voiddelegateTask(String id, UserIdDto userIdDto)Delegate Delegates a task to another user.okhttp3.CalldelegateTaskAsync(String id, UserIdDto userIdDto, ApiCallback<Void> _callback)Delegate (asynchronously) Delegates a task to another user.okhttp3.CalldelegateTaskCall(String id, UserIdDto userIdDto, ApiCallback _callback)Build call for delegateTaskApiResponse<Void>delegateTaskWithHttpInfo(String id, UserIdDto userIdDto)Delegate Delegates a task to another user.voiddeleteTask(String id)Delete Removes a task by id.okhttp3.CalldeleteTaskAsync(String id, ApiCallback<Void> _callback)Delete (asynchronously) Removes a task by id.okhttp3.CalldeleteTaskCall(String id, ApiCallback _callback)Build call for deleteTaskApiResponse<Void>deleteTaskWithHttpInfo(String id)Delete Removes a task by id.ApiClientgetApiClient()FilegetDeployedForm(String id)Get Deployed Form Retrieves the deployed form that is referenced from a given task.okhttp3.CallgetDeployedFormAsync(String id, ApiCallback<File> _callback)Get Deployed Form (asynchronously) Retrieves the deployed form that is referenced from a given task.okhttp3.CallgetDeployedFormCall(String id, ApiCallback _callback)Build call for getDeployedFormApiResponse<File>getDeployedFormWithHttpInfo(String id)Get Deployed Form Retrieves the deployed form that is referenced from a given task.FormDtogetForm(String id)Get Form Key Retrieves the form key for a task.okhttp3.CallgetFormAsync(String id, ApiCallback<FormDto> _callback)Get Form Key (asynchronously) Retrieves the form key for a task.okhttp3.CallgetFormCall(String id, ApiCallback _callback)Build call for getFormMap<String,VariableValueDto>getFormVariables(String id, String variableNames, Boolean deserializeValues)Get Task Form Variables Retrieves the form variables for a task.okhttp3.CallgetFormVariablesAsync(String id, String variableNames, Boolean deserializeValues, ApiCallback<Map<String,VariableValueDto>> _callback)Get Task Form Variables (asynchronously) Retrieves the form variables for a task.okhttp3.CallgetFormVariablesCall(String id, String variableNames, Boolean deserializeValues, ApiCallback _callback)Build call for getFormVariablesApiResponse<Map<String,VariableValueDto>>getFormVariablesWithHttpInfo(String id, String variableNames, Boolean deserializeValues)Get Task Form Variables Retrieves the form variables for a task.ApiResponse<FormDto>getFormWithHttpInfo(String id)Get Form Key Retrieves the form key for a task.FilegetRenderedForm(String id)Get Rendered Form Retrieves the rendered form for a task.okhttp3.CallgetRenderedFormAsync(String id, ApiCallback<File> _callback)Get Rendered Form (asynchronously) Retrieves the rendered form for a task.okhttp3.CallgetRenderedFormCall(String id, ApiCallback _callback)Build call for getRenderedFormApiResponse<File>getRenderedFormWithHttpInfo(String id)Get Rendered Form Retrieves the rendered form for a task.TaskDtogetTask(String id)Get Retrieves a task by id.okhttp3.CallgetTaskAsync(String id, ApiCallback<TaskDto> _callback)Get (asynchronously) Retrieves a task by id.okhttp3.CallgetTaskCall(String id, ApiCallback _callback)Build call for getTaskList<TaskDto>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)Get List Queries for tasks that fulfill a given filter.okhttp3.CallgetTasksAsync(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, ApiCallback<List<TaskDto>> _callback)Get List (asynchronously) Queries for tasks that fulfill a given filter.okhttp3.CallgetTasksCall(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, ApiCallback _callback)Build call for getTasksCountResultDtogetTasksCount(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)Get List Count Retrieves the number of tasks that fulfill a provided filter.okhttp3.CallgetTasksCountAsync(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, ApiCallback<CountResultDto> _callback)Get List Count (asynchronously) Retrieves the number of tasks that fulfill a provided filter.okhttp3.CallgetTasksCountCall(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, ApiCallback _callback)Build call for getTasksCountApiResponse<CountResultDto>getTasksCountWithHttpInfo(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)Get List Count Retrieves the number of tasks that fulfill a provided filter.ApiResponse<List<TaskDto>>getTasksWithHttpInfo(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)Get List Queries for tasks that fulfill a given filter.ApiResponse<TaskDto>getTaskWithHttpInfo(String id)Get Retrieves a task by id.voidhandleBpmnError(String id, TaskBpmnErrorDto taskBpmnErrorDto)Handle BPMN Error Reports a business error in the context of a running task by id.okhttp3.CallhandleBpmnErrorAsync(String id, TaskBpmnErrorDto taskBpmnErrorDto, ApiCallback<Void> _callback)Handle BPMN Error (asynchronously) Reports a business error in the context of a running task by id.okhttp3.CallhandleBpmnErrorCall(String id, TaskBpmnErrorDto taskBpmnErrorDto, ApiCallback _callback)Build call for handleBpmnErrorApiResponse<Void>handleBpmnErrorWithHttpInfo(String id, TaskBpmnErrorDto taskBpmnErrorDto)Handle BPMN Error Reports a business error in the context of a running task by id.voidhandleEscalation(String id, TaskEscalationDto taskEscalationDto)Handle BPMN Escalation Reports an escalation in the context of a running task by id.okhttp3.CallhandleEscalationAsync(String id, TaskEscalationDto taskEscalationDto, ApiCallback<Void> _callback)Handle BPMN Escalation (asynchronously) Reports an escalation in the context of a running task by id.okhttp3.CallhandleEscalationCall(String id, TaskEscalationDto taskEscalationDto, ApiCallback _callback)Build call for handleEscalationApiResponse<Void>handleEscalationWithHttpInfo(String id, TaskEscalationDto taskEscalationDto)Handle BPMN Escalation Reports an escalation in the context of a running task by id.List<TaskDto>queryTasks(Integer firstResult, Integer maxResults, TaskQueryDto taskQueryDto)Get List (POST) Queries for tasks that fulfill a given filter.okhttp3.CallqueryTasksAsync(Integer firstResult, Integer maxResults, TaskQueryDto taskQueryDto, ApiCallback<List<TaskDto>> _callback)Get List (POST) (asynchronously) Queries for tasks that fulfill a given filter.okhttp3.CallqueryTasksCall(Integer firstResult, Integer maxResults, TaskQueryDto taskQueryDto, ApiCallback _callback)Build call for queryTasksCountResultDtoqueryTasksCount(TaskQueryDto taskQueryDto)Get List Count (POST) Retrieves the number of tasks that fulfill the given filter.okhttp3.CallqueryTasksCountAsync(TaskQueryDto taskQueryDto, ApiCallback<CountResultDto> _callback)Get List Count (POST) (asynchronously) Retrieves the number of tasks that fulfill the given filter.okhttp3.CallqueryTasksCountCall(TaskQueryDto taskQueryDto, ApiCallback _callback)Build call for queryTasksCountApiResponse<CountResultDto>queryTasksCountWithHttpInfo(TaskQueryDto taskQueryDto)Get List Count (POST) Retrieves the number of tasks that fulfill the given filter.ApiResponse<List<TaskDto>>queryTasksWithHttpInfo(Integer firstResult, Integer maxResults, TaskQueryDto taskQueryDto)Get List (POST) Queries for tasks that fulfill a given filter.voidresolve(String id, CompleteTaskDto completeTaskDto)Resolve Resolves a task and updates execution variables.okhttp3.CallresolveAsync(String id, CompleteTaskDto completeTaskDto, ApiCallback<Void> _callback)Resolve (asynchronously) Resolves a task and updates execution variables.okhttp3.CallresolveCall(String id, CompleteTaskDto completeTaskDto, ApiCallback _callback)Build call for resolveApiResponse<Void>resolveWithHttpInfo(String id, CompleteTaskDto completeTaskDto)Resolve Resolves a task and updates execution variables.voidsetApiClient(ApiClient apiClient)voidsetAssignee(String id, UserIdDto userIdDto)Set Assignee Changes the assignee of a task to a specific user.okhttp3.CallsetAssigneeAsync(String id, UserIdDto userIdDto, ApiCallback<Void> _callback)Set Assignee (asynchronously) Changes the assignee of a task to a specific user.okhttp3.CallsetAssigneeCall(String id, UserIdDto userIdDto, ApiCallback _callback)Build call for setAssigneeApiResponse<Void>setAssigneeWithHttpInfo(String id, UserIdDto userIdDto)Set Assignee Changes the assignee of a task to a specific user.Map<String,VariableValueDto>submit(String id, CompleteTaskDto completeTaskDto)Submit Form Completes a task and updates process variables using a form submit.okhttp3.CallsubmitAsync(String id, CompleteTaskDto completeTaskDto, ApiCallback<Map<String,VariableValueDto>> _callback)Submit Form (asynchronously) Completes a task and updates process variables using a form submit.okhttp3.CallsubmitCall(String id, CompleteTaskDto completeTaskDto, ApiCallback _callback)Build call for submitApiResponse<Map<String,VariableValueDto>>submitWithHttpInfo(String id, CompleteTaskDto completeTaskDto)Submit Form Completes a task and updates process variables using a form submit.voidunclaim(String id)Unclaim Resets a task's assignee.okhttp3.CallunclaimAsync(String id, ApiCallback<Void> _callback)Unclaim (asynchronously) Resets a task's assignee.okhttp3.CallunclaimCall(String id, ApiCallback _callback)Build call for unclaimApiResponse<Void>unclaimWithHttpInfo(String id)Unclaim Resets a task's assignee.voidupdateTask(String id, TaskDto taskDto)Update Updates a task.okhttp3.CallupdateTaskAsync(String id, TaskDto taskDto, ApiCallback<Void> _callback)Update (asynchronously) Updates a task.okhttp3.CallupdateTaskCall(String id, TaskDto taskDto, ApiCallback _callback)Build call for updateTaskApiResponse<Void>updateTaskWithHttpInfo(String id, TaskDto taskDto)Update Updates a task.
-
-
-
Constructor Detail
-
TaskApi
public TaskApi()
-
TaskApi
public TaskApi(ApiClient apiClient)
-
-
Method Detail
-
getApiClient
public ApiClient getApiClient()
-
setApiClient
public void setApiClient(ApiClient apiClient)
-
claimCall
public okhttp3.Call claimCall(String id, UserIdDto userIdDto, ApiCallback _callback) throws ApiException
Build call for claim- Parameters:
id- The id of the task to claim. (required)userIdDto- Provide the id of the user that claims the task. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
claim
public void claim(String id, UserIdDto userIdDto) throws ApiException
Claim Claims a task for a specific user. **Note:** The difference with the [Set Assignee](https://docs.camunda.org/manual/7.18/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.- Parameters:
id- The id of the task to claim. (required)userIdDto- Provide the id of the user that claims the task. (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
claimWithHttpInfo
public ApiResponse<Void> claimWithHttpInfo(String id, UserIdDto userIdDto) throws ApiException
Claim Claims a task for a specific user. **Note:** The difference with the [Set Assignee](https://docs.camunda.org/manual/7.18/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.- Parameters:
id- The id of the task to claim. (required)userIdDto- Provide the id of the user that claims the task. (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
claimAsync
public okhttp3.Call claimAsync(String id, UserIdDto userIdDto, ApiCallback<Void> _callback) throws ApiException
Claim (asynchronously) Claims a task for a specific user. **Note:** The difference with the [Set Assignee](https://docs.camunda.org/manual/7.18/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.- Parameters:
id- The id of the task to claim. (required)userIdDto- Provide the id of the user that claims the task. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
completeCall
public okhttp3.Call completeCall(String id, CompleteTaskDto completeTaskDto, ApiCallback _callback) throws ApiException
Build call for complete- Parameters:
id- The id of the task to complete. (required)completeTaskDto- (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
complete
public Map<String,VariableValueDto> complete(String id, CompleteTaskDto completeTaskDto) throws ApiException
Complete Completes a task and updates process variables.- Parameters:
id- The id of the task to complete. (required)completeTaskDto- (optional)- Returns:
- Map<String, VariableValueDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
completeWithHttpInfo
public ApiResponse<Map<String,VariableValueDto>> completeWithHttpInfo(String id, CompleteTaskDto completeTaskDto) throws ApiException
Complete Completes a task and updates process variables.- Parameters:
id- The id of the task to complete. (required)completeTaskDto- (optional)- Returns:
- ApiResponse<Map<String, VariableValueDto>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
completeAsync
public okhttp3.Call completeAsync(String id, CompleteTaskDto completeTaskDto, ApiCallback<Map<String,VariableValueDto>> _callback) throws ApiException
Complete (asynchronously) Completes a task and updates process variables.- Parameters:
id- The id of the task to complete. (required)completeTaskDto- (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
createTaskCall
public okhttp3.Call createTaskCall(TaskDto taskDto, ApiCallback _callback) throws ApiException
Build call for createTask- Parameters:
taskDto- (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
createTask
public void createTask(TaskDto taskDto) throws ApiException
Create Creates a new task.- Parameters:
taskDto- (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createTaskWithHttpInfo
public ApiResponse<Void> createTaskWithHttpInfo(TaskDto taskDto) throws ApiException
Create Creates a new task.- Parameters:
taskDto- (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
createTaskAsync
public okhttp3.Call createTaskAsync(TaskDto taskDto, ApiCallback<Void> _callback) throws ApiException
Create (asynchronously) Creates a new task.- Parameters:
taskDto- (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
delegateTaskCall
public okhttp3.Call delegateTaskCall(String id, UserIdDto userIdDto, ApiCallback _callback) throws ApiException
Build call for delegateTask- Parameters:
id- The id of the task to delegate. (required)userIdDto- Provide the id of the user that the task should be delegated to. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
delegateTask
public void delegateTask(String id, UserIdDto userIdDto) throws ApiException
Delegate Delegates a task to another user.- Parameters:
id- The id of the task to delegate. (required)userIdDto- Provide the id of the user that the task should be delegated to. (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
delegateTaskWithHttpInfo
public ApiResponse<Void> delegateTaskWithHttpInfo(String id, UserIdDto userIdDto) throws ApiException
Delegate Delegates a task to another user.- Parameters:
id- The id of the task to delegate. (required)userIdDto- Provide the id of the user that the task should be delegated to. (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
delegateTaskAsync
public okhttp3.Call delegateTaskAsync(String id, UserIdDto userIdDto, ApiCallback<Void> _callback) throws ApiException
Delegate (asynchronously) Delegates a task to another user.- Parameters:
id- The id of the task to delegate. (required)userIdDto- Provide the id of the user that the task should be delegated to. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
deleteTaskCall
public okhttp3.Call deleteTaskCall(String id, ApiCallback _callback) throws ApiException
Build call for deleteTask- Parameters:
id- The id of the task to be removed. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
deleteTask
public void deleteTask(String id) throws ApiException
Delete Removes a task by id.- Parameters:
id- The id of the task to be removed. (required)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteTaskWithHttpInfo
public ApiResponse<Void> deleteTaskWithHttpInfo(String id) throws ApiException
Delete Removes a task by id.- Parameters:
id- The id of the task to be removed. (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteTaskAsync
public okhttp3.Call deleteTaskAsync(String id, ApiCallback<Void> _callback) throws ApiException
Delete (asynchronously) Removes a task by id.- Parameters:
id- The id of the task to be removed. (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
getDeployedFormCall
public okhttp3.Call getDeployedFormCall(String id, ApiCallback _callback) throws ApiException
Build call for getDeployedForm- Parameters:
id- The id of the task to get the deployed form for. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getDeployedForm
public File getDeployedForm(String id) throws ApiException
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.18/user-guide/task-forms/#embedded-task-forms).- Parameters:
id- The id of the task to get the deployed form for. (required)- Returns:
- File
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getDeployedFormWithHttpInfo
public ApiResponse<File> getDeployedFormWithHttpInfo(String id) throws ApiException
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.18/user-guide/task-forms/#embedded-task-forms).- Parameters:
id- The id of the task to get the deployed form for. (required)- Returns:
- ApiResponse<File>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getDeployedFormAsync
public okhttp3.Call getDeployedFormAsync(String id, ApiCallback<File> _callback) throws ApiException
Get Deployed Form (asynchronously) 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.18/user-guide/task-forms/#embedded-task-forms).- Parameters:
id- The id of the task to get the deployed form for. (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
getFormCall
public okhttp3.Call getFormCall(String id, ApiCallback _callback) throws ApiException
Build call for getForm- Parameters:
id- The id of the task to retrieve the form for. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getForm
public FormDto getForm(String id) throws ApiException
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.- Parameters:
id- The id of the task to retrieve the form for. (required)- Returns:
- FormDto
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getFormWithHttpInfo
public ApiResponse<FormDto> getFormWithHttpInfo(String id) throws ApiException
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.- Parameters:
id- The id of the task to retrieve the form for. (required)- Returns:
- ApiResponse<FormDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getFormAsync
public okhttp3.Call getFormAsync(String id, ApiCallback<FormDto> _callback) throws ApiException
Get Form Key (asynchronously) 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.- Parameters:
id- The id of the task to retrieve the form for. (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
getFormVariablesCall
public okhttp3.Call getFormVariablesCall(String id, String variableNames, Boolean deserializeValues, ApiCallback _callback) throws ApiException
Build call for getFormVariables- Parameters:
id- The id of the task to retrieve the variables for. (required)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)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)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getFormVariables
public Map<String,VariableValueDto> getFormVariables(String id, String variableNames, Boolean deserializeValues) throws ApiException
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.- Parameters:
id- The id of the task to retrieve the variables for. (required)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)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)- Returns:
- Map<String, VariableValueDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getFormVariablesWithHttpInfo
public ApiResponse<Map<String,VariableValueDto>> getFormVariablesWithHttpInfo(String id, String variableNames, Boolean deserializeValues) throws ApiException
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.- Parameters:
id- The id of the task to retrieve the variables for. (required)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)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)- Returns:
- ApiResponse<Map<String, VariableValueDto>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getFormVariablesAsync
public okhttp3.Call getFormVariablesAsync(String id, String variableNames, Boolean deserializeValues, ApiCallback<Map<String,VariableValueDto>> _callback) throws ApiException
Get Task Form Variables (asynchronously) 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.- Parameters:
id- The id of the task to retrieve the variables for. (required)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)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)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
getRenderedFormCall
public okhttp3.Call getRenderedFormCall(String id, ApiCallback _callback) throws ApiException
Build call for getRenderedForm- Parameters:
id- The id of the task to get the rendered form for. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getRenderedForm
public File getRenderedForm(String id) throws ApiException
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.18/user-guide/task-forms/#generated-task-forms).- Parameters:
id- The id of the task to get the rendered form for. (required)- Returns:
- File
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getRenderedFormWithHttpInfo
public ApiResponse<File> getRenderedFormWithHttpInfo(String id) throws ApiException
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.18/user-guide/task-forms/#generated-task-forms).- Parameters:
id- The id of the task to get the rendered form for. (required)- Returns:
- ApiResponse<File>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getRenderedFormAsync
public okhttp3.Call getRenderedFormAsync(String id, ApiCallback<File> _callback) throws ApiException
Get Rendered Form (asynchronously) 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.18/user-guide/task-forms/#generated-task-forms).- Parameters:
id- The id of the task to get the rendered form for. (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
getTaskCall
public okhttp3.Call getTaskCall(String id, ApiCallback _callback) throws ApiException
Build call for getTask- Parameters:
id- The id of the task to be retrieved. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getTask
public TaskDto getTask(String id) throws ApiException
Get Retrieves a task by id.- Parameters:
id- The id of the task to be retrieved. (required)- Returns:
- TaskDto
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getTaskWithHttpInfo
public ApiResponse<TaskDto> getTaskWithHttpInfo(String id) throws ApiException
Get Retrieves a task by id.- Parameters:
id- The id of the task to be retrieved. (required)- Returns:
- ApiResponse<TaskDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getTaskAsync
public okhttp3.Call getTaskAsync(String id, ApiCallback<TaskDto> _callback) throws ApiException
Get (asynchronously) Retrieves a task by id.- Parameters:
id- The id of the task to be retrieved. (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
getTasksCall
public okhttp3.Call getTasksCall(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, ApiCallback _callback) throws ApiException
Build call for getTasks- Parameters:
taskId- Restrict to task with the given id. (optional)taskIdIn- Restrict to tasks with any of the given ids. (optional)processInstanceId- Restrict to tasks that belong to process instances with the given id. (optional)processInstanceIdIn- Restrict to tasks that belong to process instances with the given ids. (optional)processInstanceBusinessKey- Restrict to tasks that belong to process instances with the given business key. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)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)processInstanceBusinessKeyLike- Restrict to tasks that have a process instance business key that has the parameter value as a substring. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)processDefinitionId- Restrict to tasks that belong to a process definition with the given id. (optional)processDefinitionKey- Restrict to tasks that belong to a process definition with the given key. (optional)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)processDefinitionName- Restrict to tasks that belong to a process definition with the given name. (optional)processDefinitionNameLike- Restrict to tasks that have a process definition name that has the parameter value as a substring. (optional)executionId- Restrict to tasks that belong to an execution with the given id. (optional)caseInstanceId- Restrict to tasks that belong to case instances with the given id. (optional)caseInstanceBusinessKey- Restrict to tasks that belong to case instances with the given business key. (optional)caseInstanceBusinessKeyLike- Restrict to tasks that have a case instance business key that has the parameter value as a substring. (optional)caseDefinitionId- Restrict to tasks that belong to a case definition with the given id. (optional)caseDefinitionKey- Restrict to tasks that belong to a case definition with the given key. (optional)caseDefinitionName- Restrict to tasks that belong to a case definition with the given name. (optional)caseDefinitionNameLike- Restrict to tasks that have a case definition name that has the parameter value as a substring. (optional)caseExecutionId- Restrict to tasks that belong to a case execution with the given id. (optional)activityInstanceIdIn- Only include tasks which belong to one of the passed and comma-separated activity instance ids. (optional)tenantIdIn- Only include tasks which belong to one of the passed and comma-separated tenant ids. (optional)withoutTenantId- Only include tasks which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)assignee- Restrict to tasks that the given user is assigned to. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigneeLike- Restrict to tasks that have an assignee that has the parameter value as a substring. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigneeIn- Only include tasks which are assigned to one of the passed and comma-separated user ids. (optional)assigneeNotIn- Only include tasks which are not assigned to one of the passed and comma-separated user ids. (optional)owner- Restrict to tasks that the given user owns. (optional)ownerExpression- Restrict to tasks that the user described by the given expression owns. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)candidateGroup- Only include tasks that are offered to the given group. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)candidateUser- Only include tasks that are offered to the given user or to one of his groups. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)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)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)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigned- If set to `true`, restricts the query to all tasks that are assigned. (optional, default to false)unassigned- If set to `true`, restricts the query to all tasks that are unassigned. (optional, default to false)taskDefinitionKey- Restrict to tasks that have the given key. (optional)taskDefinitionKeyIn- Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list. (optional)taskDefinitionKeyLike- Restrict to tasks that have a key that has the parameter value as a substring. (optional)name- Restrict to tasks that have the given name. (optional)nameNotEqual- Restrict to tasks that do not have the given name. (optional)nameLike- Restrict to tasks that have a name with the given parameter value as substring. (optional)nameNotLike- Restrict to tasks that do not have a name with the given parameter value as substring. (optional)description- Restrict to tasks that have the given description. (optional)descriptionLike- Restrict to tasks that have a description that has the parameter value as a substring. (optional)priority- Restrict to tasks that have the given priority. (optional)maxPriority- Restrict to tasks that have a lower or equal priority. (optional)minPriority- Restrict to tasks that have a higher or equal priority. (optional)dueDate- Restrict to tasks that are due on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)dueAfter- Restrict to tasks that are due after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)dueBefore- Restrict to tasks that are due before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)withoutDueDate- Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional, default to false)followUpDate- Restrict to tasks that have a followUp date on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)followUpAfter- Restrict to tasks that have a followUp date after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)followUpBefore- Restrict to tasks that have a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)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.18/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)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.18/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)createdOn- Restrict to tasks that were created on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)createdAfter- Restrict to tasks that were created after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)createdBefore- Restrict to tasks that were created before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)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.18/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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.18/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)delegationState- Restrict to tasks that are in the given delegation state. Valid values are `PENDING` and `RESOLVED`. (optional)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)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.18/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)withCandidateGroups- Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withoutCandidateGroups- Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withCandidateUsers- Only include tasks which have a candidate user. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withoutCandidateUsers- Only include tasks which have no candidate users. Value may only be `true`, as `false` is the default behavior. (optional, default to false)active- Only include active tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)suspended- Only include suspended tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)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)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)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)variableNamesIgnoreCase- Match all variable names in this query case-insensitively. If set `variableName` and `variablename` are treated as equal. (optional, default to false)variableValuesIgnoreCase- Match all variable values in this query case-insensitively. If set `variableValue` and `variablevalue` are treated as equal. (optional, default to false)parentTaskId- Restrict query to all tasks that are sub tasks of the given task. Takes a task id. (optional)sortBy- Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)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)firstResult- Pagination of results. Specifies the index of the first result to return. (optional)maxResults- Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getTasks
public List<TaskDto> 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
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.18/user-guide/process-engine/securing-custom-code/) for custom code in the user guide for details.- Parameters:
taskId- Restrict to task with the given id. (optional)taskIdIn- Restrict to tasks with any of the given ids. (optional)processInstanceId- Restrict to tasks that belong to process instances with the given id. (optional)processInstanceIdIn- Restrict to tasks that belong to process instances with the given ids. (optional)processInstanceBusinessKey- Restrict to tasks that belong to process instances with the given business key. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)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)processInstanceBusinessKeyLike- Restrict to tasks that have a process instance business key that has the parameter value as a substring. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)processDefinitionId- Restrict to tasks that belong to a process definition with the given id. (optional)processDefinitionKey- Restrict to tasks that belong to a process definition with the given key. (optional)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)processDefinitionName- Restrict to tasks that belong to a process definition with the given name. (optional)processDefinitionNameLike- Restrict to tasks that have a process definition name that has the parameter value as a substring. (optional)executionId- Restrict to tasks that belong to an execution with the given id. (optional)caseInstanceId- Restrict to tasks that belong to case instances with the given id. (optional)caseInstanceBusinessKey- Restrict to tasks that belong to case instances with the given business key. (optional)caseInstanceBusinessKeyLike- Restrict to tasks that have a case instance business key that has the parameter value as a substring. (optional)caseDefinitionId- Restrict to tasks that belong to a case definition with the given id. (optional)caseDefinitionKey- Restrict to tasks that belong to a case definition with the given key. (optional)caseDefinitionName- Restrict to tasks that belong to a case definition with the given name. (optional)caseDefinitionNameLike- Restrict to tasks that have a case definition name that has the parameter value as a substring. (optional)caseExecutionId- Restrict to tasks that belong to a case execution with the given id. (optional)activityInstanceIdIn- Only include tasks which belong to one of the passed and comma-separated activity instance ids. (optional)tenantIdIn- Only include tasks which belong to one of the passed and comma-separated tenant ids. (optional)withoutTenantId- Only include tasks which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)assignee- Restrict to tasks that the given user is assigned to. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigneeLike- Restrict to tasks that have an assignee that has the parameter value as a substring. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigneeIn- Only include tasks which are assigned to one of the passed and comma-separated user ids. (optional)assigneeNotIn- Only include tasks which are not assigned to one of the passed and comma-separated user ids. (optional)owner- Restrict to tasks that the given user owns. (optional)ownerExpression- Restrict to tasks that the user described by the given expression owns. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)candidateGroup- Only include tasks that are offered to the given group. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)candidateUser- Only include tasks that are offered to the given user or to one of his groups. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)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)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)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigned- If set to `true`, restricts the query to all tasks that are assigned. (optional, default to false)unassigned- If set to `true`, restricts the query to all tasks that are unassigned. (optional, default to false)taskDefinitionKey- Restrict to tasks that have the given key. (optional)taskDefinitionKeyIn- Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list. (optional)taskDefinitionKeyLike- Restrict to tasks that have a key that has the parameter value as a substring. (optional)name- Restrict to tasks that have the given name. (optional)nameNotEqual- Restrict to tasks that do not have the given name. (optional)nameLike- Restrict to tasks that have a name with the given parameter value as substring. (optional)nameNotLike- Restrict to tasks that do not have a name with the given parameter value as substring. (optional)description- Restrict to tasks that have the given description. (optional)descriptionLike- Restrict to tasks that have a description that has the parameter value as a substring. (optional)priority- Restrict to tasks that have the given priority. (optional)maxPriority- Restrict to tasks that have a lower or equal priority. (optional)minPriority- Restrict to tasks that have a higher or equal priority. (optional)dueDate- Restrict to tasks that are due on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)dueAfter- Restrict to tasks that are due after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)dueBefore- Restrict to tasks that are due before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)withoutDueDate- Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional, default to false)followUpDate- Restrict to tasks that have a followUp date on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)followUpAfter- Restrict to tasks that have a followUp date after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)followUpBefore- Restrict to tasks that have a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)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.18/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)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.18/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)createdOn- Restrict to tasks that were created on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)createdAfter- Restrict to tasks that were created after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)createdBefore- Restrict to tasks that were created before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)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.18/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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.18/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)delegationState- Restrict to tasks that are in the given delegation state. Valid values are `PENDING` and `RESOLVED`. (optional)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)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.18/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)withCandidateGroups- Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withoutCandidateGroups- Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withCandidateUsers- Only include tasks which have a candidate user. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withoutCandidateUsers- Only include tasks which have no candidate users. Value may only be `true`, as `false` is the default behavior. (optional, default to false)active- Only include active tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)suspended- Only include suspended tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)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)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)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)variableNamesIgnoreCase- Match all variable names in this query case-insensitively. If set `variableName` and `variablename` are treated as equal. (optional, default to false)variableValuesIgnoreCase- Match all variable values in this query case-insensitively. If set `variableValue` and `variablevalue` are treated as equal. (optional, default to false)parentTaskId- Restrict query to all tasks that are sub tasks of the given task. Takes a task id. (optional)sortBy- Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)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)firstResult- Pagination of results. Specifies the index of the first result to return. (optional)maxResults- Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)- Returns:
- List<TaskDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getTasksWithHttpInfo
public ApiResponse<List<TaskDto>> getTasksWithHttpInfo(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
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.18/user-guide/process-engine/securing-custom-code/) for custom code in the user guide for details.- Parameters:
taskId- Restrict to task with the given id. (optional)taskIdIn- Restrict to tasks with any of the given ids. (optional)processInstanceId- Restrict to tasks that belong to process instances with the given id. (optional)processInstanceIdIn- Restrict to tasks that belong to process instances with the given ids. (optional)processInstanceBusinessKey- Restrict to tasks that belong to process instances with the given business key. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)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)processInstanceBusinessKeyLike- Restrict to tasks that have a process instance business key that has the parameter value as a substring. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)processDefinitionId- Restrict to tasks that belong to a process definition with the given id. (optional)processDefinitionKey- Restrict to tasks that belong to a process definition with the given key. (optional)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)processDefinitionName- Restrict to tasks that belong to a process definition with the given name. (optional)processDefinitionNameLike- Restrict to tasks that have a process definition name that has the parameter value as a substring. (optional)executionId- Restrict to tasks that belong to an execution with the given id. (optional)caseInstanceId- Restrict to tasks that belong to case instances with the given id. (optional)caseInstanceBusinessKey- Restrict to tasks that belong to case instances with the given business key. (optional)caseInstanceBusinessKeyLike- Restrict to tasks that have a case instance business key that has the parameter value as a substring. (optional)caseDefinitionId- Restrict to tasks that belong to a case definition with the given id. (optional)caseDefinitionKey- Restrict to tasks that belong to a case definition with the given key. (optional)caseDefinitionName- Restrict to tasks that belong to a case definition with the given name. (optional)caseDefinitionNameLike- Restrict to tasks that have a case definition name that has the parameter value as a substring. (optional)caseExecutionId- Restrict to tasks that belong to a case execution with the given id. (optional)activityInstanceIdIn- Only include tasks which belong to one of the passed and comma-separated activity instance ids. (optional)tenantIdIn- Only include tasks which belong to one of the passed and comma-separated tenant ids. (optional)withoutTenantId- Only include tasks which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)assignee- Restrict to tasks that the given user is assigned to. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigneeLike- Restrict to tasks that have an assignee that has the parameter value as a substring. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigneeIn- Only include tasks which are assigned to one of the passed and comma-separated user ids. (optional)assigneeNotIn- Only include tasks which are not assigned to one of the passed and comma-separated user ids. (optional)owner- Restrict to tasks that the given user owns. (optional)ownerExpression- Restrict to tasks that the user described by the given expression owns. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)candidateGroup- Only include tasks that are offered to the given group. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)candidateUser- Only include tasks that are offered to the given user or to one of his groups. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)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)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)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigned- If set to `true`, restricts the query to all tasks that are assigned. (optional, default to false)unassigned- If set to `true`, restricts the query to all tasks that are unassigned. (optional, default to false)taskDefinitionKey- Restrict to tasks that have the given key. (optional)taskDefinitionKeyIn- Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list. (optional)taskDefinitionKeyLike- Restrict to tasks that have a key that has the parameter value as a substring. (optional)name- Restrict to tasks that have the given name. (optional)nameNotEqual- Restrict to tasks that do not have the given name. (optional)nameLike- Restrict to tasks that have a name with the given parameter value as substring. (optional)nameNotLike- Restrict to tasks that do not have a name with the given parameter value as substring. (optional)description- Restrict to tasks that have the given description. (optional)descriptionLike- Restrict to tasks that have a description that has the parameter value as a substring. (optional)priority- Restrict to tasks that have the given priority. (optional)maxPriority- Restrict to tasks that have a lower or equal priority. (optional)minPriority- Restrict to tasks that have a higher or equal priority. (optional)dueDate- Restrict to tasks that are due on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)dueAfter- Restrict to tasks that are due after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)dueBefore- Restrict to tasks that are due before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)withoutDueDate- Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional, default to false)followUpDate- Restrict to tasks that have a followUp date on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)followUpAfter- Restrict to tasks that have a followUp date after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)followUpBefore- Restrict to tasks that have a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)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.18/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)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.18/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)createdOn- Restrict to tasks that were created on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)createdAfter- Restrict to tasks that were created after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)createdBefore- Restrict to tasks that were created before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)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.18/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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.18/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)delegationState- Restrict to tasks that are in the given delegation state. Valid values are `PENDING` and `RESOLVED`. (optional)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)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.18/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)withCandidateGroups- Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withoutCandidateGroups- Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withCandidateUsers- Only include tasks which have a candidate user. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withoutCandidateUsers- Only include tasks which have no candidate users. Value may only be `true`, as `false` is the default behavior. (optional, default to false)active- Only include active tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)suspended- Only include suspended tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)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)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)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)variableNamesIgnoreCase- Match all variable names in this query case-insensitively. If set `variableName` and `variablename` are treated as equal. (optional, default to false)variableValuesIgnoreCase- Match all variable values in this query case-insensitively. If set `variableValue` and `variablevalue` are treated as equal. (optional, default to false)parentTaskId- Restrict query to all tasks that are sub tasks of the given task. Takes a task id. (optional)sortBy- Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)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)firstResult- Pagination of results. Specifies the index of the first result to return. (optional)maxResults- Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)- Returns:
- ApiResponse<List<TaskDto>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getTasksAsync
public okhttp3.Call getTasksAsync(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, ApiCallback<List<TaskDto>> _callback) throws ApiException
Get List (asynchronously) 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.18/user-guide/process-engine/securing-custom-code/) for custom code in the user guide for details.- Parameters:
taskId- Restrict to task with the given id. (optional)taskIdIn- Restrict to tasks with any of the given ids. (optional)processInstanceId- Restrict to tasks that belong to process instances with the given id. (optional)processInstanceIdIn- Restrict to tasks that belong to process instances with the given ids. (optional)processInstanceBusinessKey- Restrict to tasks that belong to process instances with the given business key. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)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)processInstanceBusinessKeyLike- Restrict to tasks that have a process instance business key that has the parameter value as a substring. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)processDefinitionId- Restrict to tasks that belong to a process definition with the given id. (optional)processDefinitionKey- Restrict to tasks that belong to a process definition with the given key. (optional)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)processDefinitionName- Restrict to tasks that belong to a process definition with the given name. (optional)processDefinitionNameLike- Restrict to tasks that have a process definition name that has the parameter value as a substring. (optional)executionId- Restrict to tasks that belong to an execution with the given id. (optional)caseInstanceId- Restrict to tasks that belong to case instances with the given id. (optional)caseInstanceBusinessKey- Restrict to tasks that belong to case instances with the given business key. (optional)caseInstanceBusinessKeyLike- Restrict to tasks that have a case instance business key that has the parameter value as a substring. (optional)caseDefinitionId- Restrict to tasks that belong to a case definition with the given id. (optional)caseDefinitionKey- Restrict to tasks that belong to a case definition with the given key. (optional)caseDefinitionName- Restrict to tasks that belong to a case definition with the given name. (optional)caseDefinitionNameLike- Restrict to tasks that have a case definition name that has the parameter value as a substring. (optional)caseExecutionId- Restrict to tasks that belong to a case execution with the given id. (optional)activityInstanceIdIn- Only include tasks which belong to one of the passed and comma-separated activity instance ids. (optional)tenantIdIn- Only include tasks which belong to one of the passed and comma-separated tenant ids. (optional)withoutTenantId- Only include tasks which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)assignee- Restrict to tasks that the given user is assigned to. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigneeLike- Restrict to tasks that have an assignee that has the parameter value as a substring. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigneeIn- Only include tasks which are assigned to one of the passed and comma-separated user ids. (optional)assigneeNotIn- Only include tasks which are not assigned to one of the passed and comma-separated user ids. (optional)owner- Restrict to tasks that the given user owns. (optional)ownerExpression- Restrict to tasks that the user described by the given expression owns. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)candidateGroup- Only include tasks that are offered to the given group. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)candidateUser- Only include tasks that are offered to the given user or to one of his groups. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)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)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)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigned- If set to `true`, restricts the query to all tasks that are assigned. (optional, default to false)unassigned- If set to `true`, restricts the query to all tasks that are unassigned. (optional, default to false)taskDefinitionKey- Restrict to tasks that have the given key. (optional)taskDefinitionKeyIn- Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list. (optional)taskDefinitionKeyLike- Restrict to tasks that have a key that has the parameter value as a substring. (optional)name- Restrict to tasks that have the given name. (optional)nameNotEqual- Restrict to tasks that do not have the given name. (optional)nameLike- Restrict to tasks that have a name with the given parameter value as substring. (optional)nameNotLike- Restrict to tasks that do not have a name with the given parameter value as substring. (optional)description- Restrict to tasks that have the given description. (optional)descriptionLike- Restrict to tasks that have a description that has the parameter value as a substring. (optional)priority- Restrict to tasks that have the given priority. (optional)maxPriority- Restrict to tasks that have a lower or equal priority. (optional)minPriority- Restrict to tasks that have a higher or equal priority. (optional)dueDate- Restrict to tasks that are due on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)dueAfter- Restrict to tasks that are due after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)dueBefore- Restrict to tasks that are due before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)withoutDueDate- Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional, default to false)followUpDate- Restrict to tasks that have a followUp date on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)followUpAfter- Restrict to tasks that have a followUp date after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)followUpBefore- Restrict to tasks that have a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)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.18/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)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.18/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)createdOn- Restrict to tasks that were created on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)createdAfter- Restrict to tasks that were created after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)createdBefore- Restrict to tasks that were created before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)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.18/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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.18/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)delegationState- Restrict to tasks that are in the given delegation state. Valid values are `PENDING` and `RESOLVED`. (optional)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)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.18/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)withCandidateGroups- Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withoutCandidateGroups- Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withCandidateUsers- Only include tasks which have a candidate user. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withoutCandidateUsers- Only include tasks which have no candidate users. Value may only be `true`, as `false` is the default behavior. (optional, default to false)active- Only include active tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)suspended- Only include suspended tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)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)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)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)variableNamesIgnoreCase- Match all variable names in this query case-insensitively. If set `variableName` and `variablename` are treated as equal. (optional, default to false)variableValuesIgnoreCase- Match all variable values in this query case-insensitively. If set `variableValue` and `variablevalue` are treated as equal. (optional, default to false)parentTaskId- Restrict query to all tasks that are sub tasks of the given task. Takes a task id. (optional)sortBy- Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)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)firstResult- Pagination of results. Specifies the index of the first result to return. (optional)maxResults- Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
getTasksCountCall
public okhttp3.Call getTasksCountCall(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, ApiCallback _callback) throws ApiException
Build call for getTasksCount- Parameters:
taskId- Restrict to task with the given id. (optional)taskIdIn- Restrict to tasks with any of the given ids. (optional)processInstanceId- Restrict to tasks that belong to process instances with the given id. (optional)processInstanceIdIn- Restrict to tasks that belong to process instances with the given ids. (optional)processInstanceBusinessKey- Restrict to tasks that belong to process instances with the given business key. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)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)processInstanceBusinessKeyLike- Restrict to tasks that have a process instance business key that has the parameter value as a substring. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)processDefinitionId- Restrict to tasks that belong to a process definition with the given id. (optional)processDefinitionKey- Restrict to tasks that belong to a process definition with the given key. (optional)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)processDefinitionName- Restrict to tasks that belong to a process definition with the given name. (optional)processDefinitionNameLike- Restrict to tasks that have a process definition name that has the parameter value as a substring. (optional)executionId- Restrict to tasks that belong to an execution with the given id. (optional)caseInstanceId- Restrict to tasks that belong to case instances with the given id. (optional)caseInstanceBusinessKey- Restrict to tasks that belong to case instances with the given business key. (optional)caseInstanceBusinessKeyLike- Restrict to tasks that have a case instance business key that has the parameter value as a substring. (optional)caseDefinitionId- Restrict to tasks that belong to a case definition with the given id. (optional)caseDefinitionKey- Restrict to tasks that belong to a case definition with the given key. (optional)caseDefinitionName- Restrict to tasks that belong to a case definition with the given name. (optional)caseDefinitionNameLike- Restrict to tasks that have a case definition name that has the parameter value as a substring. (optional)caseExecutionId- Restrict to tasks that belong to a case execution with the given id. (optional)activityInstanceIdIn- Only include tasks which belong to one of the passed and comma-separated activity instance ids. (optional)tenantIdIn- Only include tasks which belong to one of the passed and comma-separated tenant ids. (optional)withoutTenantId- Only include tasks which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)assignee- Restrict to tasks that the given user is assigned to. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigneeLike- Restrict to tasks that have an assignee that has the parameter value as a substring. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigneeIn- Only include tasks which are assigned to one of the passed and comma-separated user ids. (optional)assigneeNotIn- Only include tasks which are not assigned to one of the passed and comma-separated user ids. (optional)owner- Restrict to tasks that the given user owns. (optional)ownerExpression- Restrict to tasks that the user described by the given expression owns. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)candidateGroup- Only include tasks that are offered to the given group. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)candidateUser- Only include tasks that are offered to the given user or to one of his groups. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)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)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)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigned- If set to `true`, restricts the query to all tasks that are assigned. (optional, default to false)unassigned- If set to `true`, restricts the query to all tasks that are unassigned. (optional, default to false)taskDefinitionKey- Restrict to tasks that have the given key. (optional)taskDefinitionKeyIn- Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list. (optional)taskDefinitionKeyLike- Restrict to tasks that have a key that has the parameter value as a substring. (optional)name- Restrict to tasks that have the given name. (optional)nameNotEqual- Restrict to tasks that do not have the given name. (optional)nameLike- Restrict to tasks that have a name with the given parameter value as substring. (optional)nameNotLike- Restrict to tasks that do not have a name with the given parameter value as substring. (optional)description- Restrict to tasks that have the given description. (optional)descriptionLike- Restrict to tasks that have a description that has the parameter value as a substring. (optional)priority- Restrict to tasks that have the given priority. (optional)maxPriority- Restrict to tasks that have a lower or equal priority. (optional)minPriority- Restrict to tasks that have a higher or equal priority. (optional)dueDate- Restrict to tasks that are due on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)dueAfter- Restrict to tasks that are due after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)dueBefore- Restrict to tasks that are due before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)withoutDueDate- Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional, default to false)followUpDate- Restrict to tasks that have a followUp date on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)followUpAfter- Restrict to tasks that have a followUp date after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)followUpBefore- Restrict to tasks that have a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)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.18/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)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.18/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)createdOn- Restrict to tasks that were created on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)createdAfter- Restrict to tasks that were created after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)createdBefore- Restrict to tasks that were created before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)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.18/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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.18/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)delegationState- Restrict to tasks that are in the given delegation state. Valid values are `PENDING` and `RESOLVED`. (optional)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)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.18/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)withCandidateGroups- Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withoutCandidateGroups- Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withCandidateUsers- Only include tasks which have a candidate user. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withoutCandidateUsers- Only include tasks which have no candidate users. Value may only be `true`, as `false` is the default behavior. (optional, default to false)active- Only include active tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)suspended- Only include suspended tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)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)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)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)variableNamesIgnoreCase- Match all variable names in this query case-insensitively. If set `variableName` and `variablename` are treated as equal. (optional, default to false)variableValuesIgnoreCase- Match all variable values in this query case-insensitively. If set `variableValue` and `variablevalue` are treated as equal. (optional, default to false)parentTaskId- Restrict query to all tasks that are sub tasks of the given task. Takes a task id. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getTasksCount
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
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.18/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.18/user-guide/process-engine/securing-custom-code/) for custom code in the user guide for details.- Parameters:
taskId- Restrict to task with the given id. (optional)taskIdIn- Restrict to tasks with any of the given ids. (optional)processInstanceId- Restrict to tasks that belong to process instances with the given id. (optional)processInstanceIdIn- Restrict to tasks that belong to process instances with the given ids. (optional)processInstanceBusinessKey- Restrict to tasks that belong to process instances with the given business key. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)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)processInstanceBusinessKeyLike- Restrict to tasks that have a process instance business key that has the parameter value as a substring. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)processDefinitionId- Restrict to tasks that belong to a process definition with the given id. (optional)processDefinitionKey- Restrict to tasks that belong to a process definition with the given key. (optional)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)processDefinitionName- Restrict to tasks that belong to a process definition with the given name. (optional)processDefinitionNameLike- Restrict to tasks that have a process definition name that has the parameter value as a substring. (optional)executionId- Restrict to tasks that belong to an execution with the given id. (optional)caseInstanceId- Restrict to tasks that belong to case instances with the given id. (optional)caseInstanceBusinessKey- Restrict to tasks that belong to case instances with the given business key. (optional)caseInstanceBusinessKeyLike- Restrict to tasks that have a case instance business key that has the parameter value as a substring. (optional)caseDefinitionId- Restrict to tasks that belong to a case definition with the given id. (optional)caseDefinitionKey- Restrict to tasks that belong to a case definition with the given key. (optional)caseDefinitionName- Restrict to tasks that belong to a case definition with the given name. (optional)caseDefinitionNameLike- Restrict to tasks that have a case definition name that has the parameter value as a substring. (optional)caseExecutionId- Restrict to tasks that belong to a case execution with the given id. (optional)activityInstanceIdIn- Only include tasks which belong to one of the passed and comma-separated activity instance ids. (optional)tenantIdIn- Only include tasks which belong to one of the passed and comma-separated tenant ids. (optional)withoutTenantId- Only include tasks which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)assignee- Restrict to tasks that the given user is assigned to. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigneeLike- Restrict to tasks that have an assignee that has the parameter value as a substring. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigneeIn- Only include tasks which are assigned to one of the passed and comma-separated user ids. (optional)assigneeNotIn- Only include tasks which are not assigned to one of the passed and comma-separated user ids. (optional)owner- Restrict to tasks that the given user owns. (optional)ownerExpression- Restrict to tasks that the user described by the given expression owns. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)candidateGroup- Only include tasks that are offered to the given group. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)candidateUser- Only include tasks that are offered to the given user or to one of his groups. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)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)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)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigned- If set to `true`, restricts the query to all tasks that are assigned. (optional, default to false)unassigned- If set to `true`, restricts the query to all tasks that are unassigned. (optional, default to false)taskDefinitionKey- Restrict to tasks that have the given key. (optional)taskDefinitionKeyIn- Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list. (optional)taskDefinitionKeyLike- Restrict to tasks that have a key that has the parameter value as a substring. (optional)name- Restrict to tasks that have the given name. (optional)nameNotEqual- Restrict to tasks that do not have the given name. (optional)nameLike- Restrict to tasks that have a name with the given parameter value as substring. (optional)nameNotLike- Restrict to tasks that do not have a name with the given parameter value as substring. (optional)description- Restrict to tasks that have the given description. (optional)descriptionLike- Restrict to tasks that have a description that has the parameter value as a substring. (optional)priority- Restrict to tasks that have the given priority. (optional)maxPriority- Restrict to tasks that have a lower or equal priority. (optional)minPriority- Restrict to tasks that have a higher or equal priority. (optional)dueDate- Restrict to tasks that are due on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)dueAfter- Restrict to tasks that are due after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)dueBefore- Restrict to tasks that are due before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)withoutDueDate- Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional, default to false)followUpDate- Restrict to tasks that have a followUp date on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)followUpAfter- Restrict to tasks that have a followUp date after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)followUpBefore- Restrict to tasks that have a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)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.18/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)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.18/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)createdOn- Restrict to tasks that were created on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)createdAfter- Restrict to tasks that were created after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)createdBefore- Restrict to tasks that were created before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)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.18/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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.18/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)delegationState- Restrict to tasks that are in the given delegation state. Valid values are `PENDING` and `RESOLVED`. (optional)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)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.18/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)withCandidateGroups- Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withoutCandidateGroups- Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withCandidateUsers- Only include tasks which have a candidate user. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withoutCandidateUsers- Only include tasks which have no candidate users. Value may only be `true`, as `false` is the default behavior. (optional, default to false)active- Only include active tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)suspended- Only include suspended tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)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)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)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)variableNamesIgnoreCase- Match all variable names in this query case-insensitively. If set `variableName` and `variablename` are treated as equal. (optional, default to false)variableValuesIgnoreCase- Match all variable values in this query case-insensitively. If set `variableValue` and `variablevalue` are treated as equal. (optional, default to false)parentTaskId- Restrict query to all tasks that are sub tasks of the given task. Takes a task id. (optional)- Returns:
- CountResultDto
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getTasksCountWithHttpInfo
public ApiResponse<CountResultDto> getTasksCountWithHttpInfo(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
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.18/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.18/user-guide/process-engine/securing-custom-code/) for custom code in the user guide for details.- Parameters:
taskId- Restrict to task with the given id. (optional)taskIdIn- Restrict to tasks with any of the given ids. (optional)processInstanceId- Restrict to tasks that belong to process instances with the given id. (optional)processInstanceIdIn- Restrict to tasks that belong to process instances with the given ids. (optional)processInstanceBusinessKey- Restrict to tasks that belong to process instances with the given business key. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)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)processInstanceBusinessKeyLike- Restrict to tasks that have a process instance business key that has the parameter value as a substring. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)processDefinitionId- Restrict to tasks that belong to a process definition with the given id. (optional)processDefinitionKey- Restrict to tasks that belong to a process definition with the given key. (optional)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)processDefinitionName- Restrict to tasks that belong to a process definition with the given name. (optional)processDefinitionNameLike- Restrict to tasks that have a process definition name that has the parameter value as a substring. (optional)executionId- Restrict to tasks that belong to an execution with the given id. (optional)caseInstanceId- Restrict to tasks that belong to case instances with the given id. (optional)caseInstanceBusinessKey- Restrict to tasks that belong to case instances with the given business key. (optional)caseInstanceBusinessKeyLike- Restrict to tasks that have a case instance business key that has the parameter value as a substring. (optional)caseDefinitionId- Restrict to tasks that belong to a case definition with the given id. (optional)caseDefinitionKey- Restrict to tasks that belong to a case definition with the given key. (optional)caseDefinitionName- Restrict to tasks that belong to a case definition with the given name. (optional)caseDefinitionNameLike- Restrict to tasks that have a case definition name that has the parameter value as a substring. (optional)caseExecutionId- Restrict to tasks that belong to a case execution with the given id. (optional)activityInstanceIdIn- Only include tasks which belong to one of the passed and comma-separated activity instance ids. (optional)tenantIdIn- Only include tasks which belong to one of the passed and comma-separated tenant ids. (optional)withoutTenantId- Only include tasks which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)assignee- Restrict to tasks that the given user is assigned to. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigneeLike- Restrict to tasks that have an assignee that has the parameter value as a substring. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigneeIn- Only include tasks which are assigned to one of the passed and comma-separated user ids. (optional)assigneeNotIn- Only include tasks which are not assigned to one of the passed and comma-separated user ids. (optional)owner- Restrict to tasks that the given user owns. (optional)ownerExpression- Restrict to tasks that the user described by the given expression owns. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)candidateGroup- Only include tasks that are offered to the given group. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)candidateUser- Only include tasks that are offered to the given user or to one of his groups. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)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)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)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigned- If set to `true`, restricts the query to all tasks that are assigned. (optional, default to false)unassigned- If set to `true`, restricts the query to all tasks that are unassigned. (optional, default to false)taskDefinitionKey- Restrict to tasks that have the given key. (optional)taskDefinitionKeyIn- Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list. (optional)taskDefinitionKeyLike- Restrict to tasks that have a key that has the parameter value as a substring. (optional)name- Restrict to tasks that have the given name. (optional)nameNotEqual- Restrict to tasks that do not have the given name. (optional)nameLike- Restrict to tasks that have a name with the given parameter value as substring. (optional)nameNotLike- Restrict to tasks that do not have a name with the given parameter value as substring. (optional)description- Restrict to tasks that have the given description. (optional)descriptionLike- Restrict to tasks that have a description that has the parameter value as a substring. (optional)priority- Restrict to tasks that have the given priority. (optional)maxPriority- Restrict to tasks that have a lower or equal priority. (optional)minPriority- Restrict to tasks that have a higher or equal priority. (optional)dueDate- Restrict to tasks that are due on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)dueAfter- Restrict to tasks that are due after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)dueBefore- Restrict to tasks that are due before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)withoutDueDate- Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional, default to false)followUpDate- Restrict to tasks that have a followUp date on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)followUpAfter- Restrict to tasks that have a followUp date after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)followUpBefore- Restrict to tasks that have a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)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.18/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)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.18/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)createdOn- Restrict to tasks that were created on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)createdAfter- Restrict to tasks that were created after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)createdBefore- Restrict to tasks that were created before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)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.18/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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.18/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)delegationState- Restrict to tasks that are in the given delegation state. Valid values are `PENDING` and `RESOLVED`. (optional)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)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.18/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)withCandidateGroups- Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withoutCandidateGroups- Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withCandidateUsers- Only include tasks which have a candidate user. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withoutCandidateUsers- Only include tasks which have no candidate users. Value may only be `true`, as `false` is the default behavior. (optional, default to false)active- Only include active tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)suspended- Only include suspended tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)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)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)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)variableNamesIgnoreCase- Match all variable names in this query case-insensitively. If set `variableName` and `variablename` are treated as equal. (optional, default to false)variableValuesIgnoreCase- Match all variable values in this query case-insensitively. If set `variableValue` and `variablevalue` are treated as equal. (optional, default to false)parentTaskId- Restrict query to all tasks that are sub tasks of the given task. Takes a task id. (optional)- Returns:
- ApiResponse<CountResultDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getTasksCountAsync
public okhttp3.Call getTasksCountAsync(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, ApiCallback<CountResultDto> _callback) throws ApiException
Get List Count (asynchronously) 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.18/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.18/user-guide/process-engine/securing-custom-code/) for custom code in the user guide for details.- Parameters:
taskId- Restrict to task with the given id. (optional)taskIdIn- Restrict to tasks with any of the given ids. (optional)processInstanceId- Restrict to tasks that belong to process instances with the given id. (optional)processInstanceIdIn- Restrict to tasks that belong to process instances with the given ids. (optional)processInstanceBusinessKey- Restrict to tasks that belong to process instances with the given business key. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)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)processInstanceBusinessKeyLike- Restrict to tasks that have a process instance business key that has the parameter value as a substring. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)processDefinitionId- Restrict to tasks that belong to a process definition with the given id. (optional)processDefinitionKey- Restrict to tasks that belong to a process definition with the given key. (optional)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)processDefinitionName- Restrict to tasks that belong to a process definition with the given name. (optional)processDefinitionNameLike- Restrict to tasks that have a process definition name that has the parameter value as a substring. (optional)executionId- Restrict to tasks that belong to an execution with the given id. (optional)caseInstanceId- Restrict to tasks that belong to case instances with the given id. (optional)caseInstanceBusinessKey- Restrict to tasks that belong to case instances with the given business key. (optional)caseInstanceBusinessKeyLike- Restrict to tasks that have a case instance business key that has the parameter value as a substring. (optional)caseDefinitionId- Restrict to tasks that belong to a case definition with the given id. (optional)caseDefinitionKey- Restrict to tasks that belong to a case definition with the given key. (optional)caseDefinitionName- Restrict to tasks that belong to a case definition with the given name. (optional)caseDefinitionNameLike- Restrict to tasks that have a case definition name that has the parameter value as a substring. (optional)caseExecutionId- Restrict to tasks that belong to a case execution with the given id. (optional)activityInstanceIdIn- Only include tasks which belong to one of the passed and comma-separated activity instance ids. (optional)tenantIdIn- Only include tasks which belong to one of the passed and comma-separated tenant ids. (optional)withoutTenantId- Only include tasks which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional, default to false)assignee- Restrict to tasks that the given user is assigned to. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigneeLike- Restrict to tasks that have an assignee that has the parameter value as a substring. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigneeIn- Only include tasks which are assigned to one of the passed and comma-separated user ids. (optional)assigneeNotIn- Only include tasks which are not assigned to one of the passed and comma-separated user ids. (optional)owner- Restrict to tasks that the given user owns. (optional)ownerExpression- Restrict to tasks that the user described by the given expression owns. See the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)candidateGroup- Only include tasks that are offered to the given group. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)candidateUser- Only include tasks that are offered to the given user or to one of his groups. (optional)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)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)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)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.18/user-guide/process-engine/expression-language/#internal-context-functions) for more information on available functions. (optional)assigned- If set to `true`, restricts the query to all tasks that are assigned. (optional, default to false)unassigned- If set to `true`, restricts the query to all tasks that are unassigned. (optional, default to false)taskDefinitionKey- Restrict to tasks that have the given key. (optional)taskDefinitionKeyIn- Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list. (optional)taskDefinitionKeyLike- Restrict to tasks that have a key that has the parameter value as a substring. (optional)name- Restrict to tasks that have the given name. (optional)nameNotEqual- Restrict to tasks that do not have the given name. (optional)nameLike- Restrict to tasks that have a name with the given parameter value as substring. (optional)nameNotLike- Restrict to tasks that do not have a name with the given parameter value as substring. (optional)description- Restrict to tasks that have the given description. (optional)descriptionLike- Restrict to tasks that have a description that has the parameter value as a substring. (optional)priority- Restrict to tasks that have the given priority. (optional)maxPriority- Restrict to tasks that have a lower or equal priority. (optional)minPriority- Restrict to tasks that have a higher or equal priority. (optional)dueDate- Restrict to tasks that are due on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)dueAfter- Restrict to tasks that are due after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)dueBefore- Restrict to tasks that are due before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)withoutDueDate- Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional, default to false)followUpDate- Restrict to tasks that have a followUp date on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)followUpAfter- Restrict to tasks that have a followUp date after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)followUpBefore- Restrict to tasks that have a followUp date before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)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.18/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)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.18/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)createdOn- Restrict to tasks that were created on the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)createdAfter- Restrict to tasks that were created after the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)createdBefore- Restrict to tasks that were created before the given date. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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)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.18/user-guide/process-engine/delegation-code/#task-listener-event-lifecycle) is considered as updating the task. By [default](https://docs.camunda.org/manual/7.18/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)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.18/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.18/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)delegationState- Restrict to tasks that are in the given delegation state. Valid values are `PENDING` and `RESOLVED`. (optional)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)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.18/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)withCandidateGroups- Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withoutCandidateGroups- Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withCandidateUsers- Only include tasks which have a candidate user. Value may only be `true`, as `false` is the default behavior. (optional, default to false)withoutCandidateUsers- Only include tasks which have no candidate users. Value may only be `true`, as `false` is the default behavior. (optional, default to false)active- Only include active tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)suspended- Only include suspended tasks. Value may only be `true`, as `false` is the default behavior. (optional, default to false)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)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)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)variableNamesIgnoreCase- Match all variable names in this query case-insensitively. If set `variableName` and `variablename` are treated as equal. (optional, default to false)variableValuesIgnoreCase- Match all variable values in this query case-insensitively. If set `variableValue` and `variablevalue` are treated as equal. (optional, default to false)parentTaskId- Restrict query to all tasks that are sub tasks of the given task. Takes a task id. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
handleBpmnErrorCall
public okhttp3.Call handleBpmnErrorCall(String id, TaskBpmnErrorDto taskBpmnErrorDto, ApiCallback _callback) throws ApiException
Build call for handleBpmnError- Parameters:
id- The id of the task a BPMN error is reported for. (required)taskBpmnErrorDto- (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
handleBpmnError
public void handleBpmnError(String id, TaskBpmnErrorDto taskBpmnErrorDto) throws ApiException
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.18/reference/bpmn20/tasks/user-task/#reporting-bpmn-error) in User Tasks.- Parameters:
id- The id of the task a BPMN error is reported for. (required)taskBpmnErrorDto- (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
handleBpmnErrorWithHttpInfo
public ApiResponse<Void> handleBpmnErrorWithHttpInfo(String id, TaskBpmnErrorDto taskBpmnErrorDto) throws ApiException
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.18/reference/bpmn20/tasks/user-task/#reporting-bpmn-error) in User Tasks.- Parameters:
id- The id of the task a BPMN error is reported for. (required)taskBpmnErrorDto- (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
handleBpmnErrorAsync
public okhttp3.Call handleBpmnErrorAsync(String id, TaskBpmnErrorDto taskBpmnErrorDto, ApiCallback<Void> _callback) throws ApiException
Handle BPMN Error (asynchronously) 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.18/reference/bpmn20/tasks/user-task/#reporting-bpmn-error) in User Tasks.- Parameters:
id- The id of the task a BPMN error is reported for. (required)taskBpmnErrorDto- (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
handleEscalationCall
public okhttp3.Call handleEscalationCall(String id, TaskEscalationDto taskEscalationDto, ApiCallback _callback) throws ApiException
Build call for handleEscalation- Parameters:
id- The id of the task in which context a BPMN escalation is reported. (required)taskEscalationDto- (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
handleEscalation
public void handleEscalation(String id, TaskEscalationDto taskEscalationDto) throws ApiException
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.18/reference/bpmn20/tasks/user-task/#reporting-bpmn-escalation) in User Tasks.- Parameters:
id- The id of the task in which context a BPMN escalation is reported. (required)taskEscalationDto- (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
handleEscalationWithHttpInfo
public ApiResponse<Void> handleEscalationWithHttpInfo(String id, TaskEscalationDto taskEscalationDto) throws ApiException
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.18/reference/bpmn20/tasks/user-task/#reporting-bpmn-escalation) in User Tasks.- Parameters:
id- The id of the task in which context a BPMN escalation is reported. (required)taskEscalationDto- (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
handleEscalationAsync
public okhttp3.Call handleEscalationAsync(String id, TaskEscalationDto taskEscalationDto, ApiCallback<Void> _callback) throws ApiException
Handle BPMN Escalation (asynchronously) 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.18/reference/bpmn20/tasks/user-task/#reporting-bpmn-escalation) in User Tasks.- Parameters:
id- The id of the task in which context a BPMN escalation is reported. (required)taskEscalationDto- (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
queryTasksCall
public okhttp3.Call queryTasksCall(Integer firstResult, Integer maxResults, TaskQueryDto taskQueryDto, ApiCallback _callback) throws ApiException
Build call for queryTasks- Parameters:
firstResult- Pagination of results. Specifies the index of the first result to return. (optional)maxResults- Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)taskQueryDto- (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
queryTasks
public List<TaskDto> queryTasks(Integer firstResult, Integer maxResults, TaskQueryDto taskQueryDto) throws ApiException
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.18/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.18/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.18/user-guide/process-engine/securing-custom-code/) in the user guide for details.- Parameters:
firstResult- Pagination of results. Specifies the index of the first result to return. (optional)maxResults- Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)taskQueryDto- (optional)- Returns:
- List<TaskDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
queryTasksWithHttpInfo
public ApiResponse<List<TaskDto>> queryTasksWithHttpInfo(Integer firstResult, Integer maxResults, TaskQueryDto taskQueryDto) throws ApiException
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.18/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.18/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.18/user-guide/process-engine/securing-custom-code/) in the user guide for details.- Parameters:
firstResult- Pagination of results. Specifies the index of the first result to return. (optional)maxResults- Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)taskQueryDto- (optional)- Returns:
- ApiResponse<List<TaskDto>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
queryTasksAsync
public okhttp3.Call queryTasksAsync(Integer firstResult, Integer maxResults, TaskQueryDto taskQueryDto, ApiCallback<List<TaskDto>> _callback) throws ApiException
Get List (POST) (asynchronously) Queries for tasks that fulfill a given filter. This method is slightly more powerful than the [Get Tasks](https://docs.camunda.org/manual/7.18/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.18/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.18/user-guide/process-engine/securing-custom-code/) in the user guide for details.- Parameters:
firstResult- Pagination of results. Specifies the index of the first result to return. (optional)maxResults- Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)taskQueryDto- (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
queryTasksCountCall
public okhttp3.Call queryTasksCountCall(TaskQueryDto taskQueryDto, ApiCallback _callback) throws ApiException
Build call for queryTasksCount- Parameters:
taskQueryDto- (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
queryTasksCount
public CountResultDto queryTasksCount(TaskQueryDto taskQueryDto) throws ApiException
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.18/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.18/user-guide/process-engine/securing-custom-code/) in the user guide for details.- Parameters:
taskQueryDto- (optional)- Returns:
- CountResultDto
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
queryTasksCountWithHttpInfo
public ApiResponse<CountResultDto> queryTasksCountWithHttpInfo(TaskQueryDto taskQueryDto) throws ApiException
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.18/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.18/user-guide/process-engine/securing-custom-code/) in the user guide for details.- Parameters:
taskQueryDto- (optional)- Returns:
- ApiResponse<CountResultDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
queryTasksCountAsync
public okhttp3.Call queryTasksCountAsync(TaskQueryDto taskQueryDto, ApiCallback<CountResultDto> _callback) throws ApiException
Get List Count (POST) (asynchronously) 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.18/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.18/user-guide/process-engine/securing-custom-code/) in the user guide for details.- Parameters:
taskQueryDto- (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
resolveCall
public okhttp3.Call resolveCall(String id, CompleteTaskDto completeTaskDto, ApiCallback _callback) throws ApiException
Build call for resolve- Parameters:
id- The id of the task to resolve. (required)completeTaskDto- (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
resolve
public void resolve(String id, CompleteTaskDto completeTaskDto) throws ApiException
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.- Parameters:
id- The id of the task to resolve. (required)completeTaskDto- (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
resolveWithHttpInfo
public ApiResponse<Void> resolveWithHttpInfo(String id, CompleteTaskDto completeTaskDto) throws ApiException
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.- Parameters:
id- The id of the task to resolve. (required)completeTaskDto- (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
resolveAsync
public okhttp3.Call resolveAsync(String id, CompleteTaskDto completeTaskDto, ApiCallback<Void> _callback) throws ApiException
Resolve (asynchronously) 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.- Parameters:
id- The id of the task to resolve. (required)completeTaskDto- (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
setAssigneeCall
public okhttp3.Call setAssigneeCall(String id, UserIdDto userIdDto, ApiCallback _callback) throws ApiException
Build call for setAssignee- Parameters:
id- The id of the task to set the assignee for. (required)userIdDto- Provide the id of the user that will be the assignee of the task. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
setAssignee
public void setAssignee(String id, UserIdDto userIdDto) throws ApiException
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.18/reference/rest/task/post-claim/) method is that this method does not check if the task already has a user assigned to it.- Parameters:
id- The id of the task to set the assignee for. (required)userIdDto- Provide the id of the user that will be the assignee of the task. (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
setAssigneeWithHttpInfo
public ApiResponse<Void> setAssigneeWithHttpInfo(String id, UserIdDto userIdDto) throws ApiException
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.18/reference/rest/task/post-claim/) method is that this method does not check if the task already has a user assigned to it.- Parameters:
id- The id of the task to set the assignee for. (required)userIdDto- Provide the id of the user that will be the assignee of the task. (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
setAssigneeAsync
public okhttp3.Call setAssigneeAsync(String id, UserIdDto userIdDto, ApiCallback<Void> _callback) throws ApiException
Set Assignee (asynchronously) Changes the assignee of a task to a specific user. **Note:** The difference with the [Claim Task](https://docs.camunda.org/manual/7.18/reference/rest/task/post-claim/) method is that this method does not check if the task already has a user assigned to it.- Parameters:
id- The id of the task to set the assignee for. (required)userIdDto- Provide the id of the user that will be the assignee of the task. (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
submitCall
public okhttp3.Call submitCall(String id, CompleteTaskDto completeTaskDto, ApiCallback _callback) throws ApiException
Build call for submit- Parameters:
id- The id of the task to submit the form for. (required)completeTaskDto- (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
submit
public Map<String,VariableValueDto> submit(String id, CompleteTaskDto completeTaskDto) throws ApiException
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.18/user-guide/task-forms/_index/#generated-task-forms) section of the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/) for more information.- Parameters:
id- The id of the task to submit the form for. (required)completeTaskDto- (optional)- Returns:
- Map<String, VariableValueDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
submitWithHttpInfo
public ApiResponse<Map<String,VariableValueDto>> submitWithHttpInfo(String id, CompleteTaskDto completeTaskDto) throws ApiException
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.18/user-guide/task-forms/_index/#generated-task-forms) section of the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/) for more information.- Parameters:
id- The id of the task to submit the form for. (required)completeTaskDto- (optional)- Returns:
- ApiResponse<Map<String, VariableValueDto>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
submitAsync
public okhttp3.Call submitAsync(String id, CompleteTaskDto completeTaskDto, ApiCallback<Map<String,VariableValueDto>> _callback) throws ApiException
Submit Form (asynchronously) 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.18/user-guide/task-forms/_index/#generated-task-forms) section of the [User Guide](https://docs.camunda.org/manual/7.18/user-guide/) for more information.- Parameters:
id- The id of the task to submit the form for. (required)completeTaskDto- (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
unclaimCall
public okhttp3.Call unclaimCall(String id, ApiCallback _callback) throws ApiException
Build call for unclaim- Parameters:
id- The id of the task to unclaim. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
unclaim
public void unclaim(String id) throws ApiException
Unclaim Resets a task's assignee. If successful, the task is not assigned to a user.- Parameters:
id- The id of the task to unclaim. (required)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
unclaimWithHttpInfo
public ApiResponse<Void> unclaimWithHttpInfo(String id) throws ApiException
Unclaim Resets a task's assignee. If successful, the task is not assigned to a user.- Parameters:
id- The id of the task to unclaim. (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
unclaimAsync
public okhttp3.Call unclaimAsync(String id, ApiCallback<Void> _callback) throws ApiException
Unclaim (asynchronously) Resets a task's assignee. If successful, the task is not assigned to a user.- Parameters:
id- The id of the task to unclaim. (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
updateTaskCall
public okhttp3.Call updateTaskCall(String id, TaskDto taskDto, ApiCallback _callback) throws ApiException
Build call for updateTask- Parameters:
id- The id of the task to be updated. (required)taskDto- (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
updateTask
public void updateTask(String id, TaskDto taskDto) throws ApiException
Update Updates a task.- Parameters:
id- The id of the task to be updated. (required)taskDto- (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateTaskWithHttpInfo
public ApiResponse<Void> updateTaskWithHttpInfo(String id, TaskDto taskDto) throws ApiException
Update Updates a task.- Parameters:
id- The id of the task to be updated. (required)taskDto- (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateTaskAsync
public okhttp3.Call updateTaskAsync(String id, TaskDto taskDto, ApiCallback<Void> _callback) throws ApiException
Update (asynchronously) Updates a task.- Parameters:
id- The id of the task to be updated. (required)taskDto- (optional)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object
-
-