Package org.openapitools.client.api
Class HistoricTaskInstanceApi
- java.lang.Object
-
- org.openapitools.client.api.HistoricTaskInstanceApi
-
public class HistoricTaskInstanceApi extends Object
-
-
Constructor Summary
Constructors Constructor Description HistoricTaskInstanceApi()HistoricTaskInstanceApi(ApiClient apiClient)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApiClientgetApiClient()List<HistoricTaskInstanceReportResultDto>getHistoricTaskInstanceReport(String reportType, String periodUnit, Date completedBefore, Date completedAfter, String groupBy)Get Task Report (Historic) Retrieves a report of completed tasks.okhttp3.CallgetHistoricTaskInstanceReportAsync(String reportType, String periodUnit, Date completedBefore, Date completedAfter, String groupBy, ApiCallback<List<HistoricTaskInstanceReportResultDto>> _callback)Get Task Report (Historic) (asynchronously) Retrieves a report of completed tasks.okhttp3.CallgetHistoricTaskInstanceReportCall(String reportType, String periodUnit, Date completedBefore, Date completedAfter, String groupBy, ApiCallback _callback)Build call for getHistoricTaskInstanceReportApiResponse<List<HistoricTaskInstanceReportResultDto>>getHistoricTaskInstanceReportWithHttpInfo(String reportType, String periodUnit, Date completedBefore, Date completedAfter, String groupBy)Get Task Report (Historic) Retrieves a report of completed tasks.List<HistoricTaskInstanceDto>getHistoricTaskInstances(String taskId, String taskParentTaskId, String processInstanceId, String processInstanceBusinessKey, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String executionId, String processDefinitionId, String processDefinitionKey, String processDefinitionName, String caseInstanceId, String caseExecutionId, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String activityInstanceIdIn, String taskName, String taskNameLike, String taskDescription, String taskDescriptionLike, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDeleteReason, String taskDeleteReasonLike, String taskAssignee, String taskAssigneeLike, String taskOwner, String taskOwnerLike, Integer taskPriority, Boolean assigned, Boolean unassigned, Boolean finished, Boolean unfinished, Boolean processFinished, Boolean processUnfinished, Date taskDueDate, Date taskDueDateBefore, Date taskDueDateAfter, Boolean withoutTaskDueDate, Date taskFollowUpDate, Date taskFollowUpDateBefore, Date taskFollowUpDateAfter, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, String tenantIdIn, Boolean withoutTenantId, String taskVariables, String processVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String taskInvolvedUser, String taskInvolvedGroup, String taskHadCandidateUser, String taskHadCandidateGroup, Boolean withCandidateGroups, Boolean withoutCandidateGroups, String sortBy, String sortOrder, Integer firstResult, Integer maxResults)Get Tasks (Historic) Queries for historic tasks that fulfill the given parameters.okhttp3.CallgetHistoricTaskInstancesAsync(String taskId, String taskParentTaskId, String processInstanceId, String processInstanceBusinessKey, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String executionId, String processDefinitionId, String processDefinitionKey, String processDefinitionName, String caseInstanceId, String caseExecutionId, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String activityInstanceIdIn, String taskName, String taskNameLike, String taskDescription, String taskDescriptionLike, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDeleteReason, String taskDeleteReasonLike, String taskAssignee, String taskAssigneeLike, String taskOwner, String taskOwnerLike, Integer taskPriority, Boolean assigned, Boolean unassigned, Boolean finished, Boolean unfinished, Boolean processFinished, Boolean processUnfinished, Date taskDueDate, Date taskDueDateBefore, Date taskDueDateAfter, Boolean withoutTaskDueDate, Date taskFollowUpDate, Date taskFollowUpDateBefore, Date taskFollowUpDateAfter, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, String tenantIdIn, Boolean withoutTenantId, String taskVariables, String processVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String taskInvolvedUser, String taskInvolvedGroup, String taskHadCandidateUser, String taskHadCandidateGroup, Boolean withCandidateGroups, Boolean withoutCandidateGroups, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, ApiCallback<List<HistoricTaskInstanceDto>> _callback)Get Tasks (Historic) (asynchronously) Queries for historic tasks that fulfill the given parameters.okhttp3.CallgetHistoricTaskInstancesCall(String taskId, String taskParentTaskId, String processInstanceId, String processInstanceBusinessKey, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String executionId, String processDefinitionId, String processDefinitionKey, String processDefinitionName, String caseInstanceId, String caseExecutionId, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String activityInstanceIdIn, String taskName, String taskNameLike, String taskDescription, String taskDescriptionLike, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDeleteReason, String taskDeleteReasonLike, String taskAssignee, String taskAssigneeLike, String taskOwner, String taskOwnerLike, Integer taskPriority, Boolean assigned, Boolean unassigned, Boolean finished, Boolean unfinished, Boolean processFinished, Boolean processUnfinished, Date taskDueDate, Date taskDueDateBefore, Date taskDueDateAfter, Boolean withoutTaskDueDate, Date taskFollowUpDate, Date taskFollowUpDateBefore, Date taskFollowUpDateAfter, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, String tenantIdIn, Boolean withoutTenantId, String taskVariables, String processVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String taskInvolvedUser, String taskInvolvedGroup, String taskHadCandidateUser, String taskHadCandidateGroup, Boolean withCandidateGroups, Boolean withoutCandidateGroups, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, ApiCallback _callback)Build call for getHistoricTaskInstancesCountResultDtogetHistoricTaskInstancesCount(String taskId, String taskParentTaskId, String processInstanceId, String processInstanceBusinessKey, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String executionId, String processDefinitionId, String processDefinitionKey, String processDefinitionName, String caseInstanceId, String caseExecutionId, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String activityInstanceIdIn, String taskName, String taskNameLike, String taskDescription, String taskDescriptionLike, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDeleteReason, String taskDeleteReasonLike, String taskAssignee, String taskAssigneeLike, String taskOwner, String taskOwnerLike, Integer taskPriority, Boolean assigned, Boolean unassigned, Boolean finished, Boolean unfinished, Boolean processFinished, Boolean processUnfinished, Date taskDueDate, Date taskDueDateBefore, Date taskDueDateAfter, Boolean withoutTaskDueDate, Date taskFollowUpDate, Date taskFollowUpDateBefore, Date taskFollowUpDateAfter, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, String tenantIdIn, Boolean withoutTenantId, String taskVariables, String processVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String taskInvolvedUser, String taskInvolvedGroup, String taskHadCandidateUser, String taskHadCandidateGroup, Boolean withCandidateGroups, Boolean withoutCandidateGroups)Get Task Count Queries for the number of historic tasks that fulfill the given parameters.okhttp3.CallgetHistoricTaskInstancesCountAsync(String taskId, String taskParentTaskId, String processInstanceId, String processInstanceBusinessKey, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String executionId, String processDefinitionId, String processDefinitionKey, String processDefinitionName, String caseInstanceId, String caseExecutionId, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String activityInstanceIdIn, String taskName, String taskNameLike, String taskDescription, String taskDescriptionLike, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDeleteReason, String taskDeleteReasonLike, String taskAssignee, String taskAssigneeLike, String taskOwner, String taskOwnerLike, Integer taskPriority, Boolean assigned, Boolean unassigned, Boolean finished, Boolean unfinished, Boolean processFinished, Boolean processUnfinished, Date taskDueDate, Date taskDueDateBefore, Date taskDueDateAfter, Boolean withoutTaskDueDate, Date taskFollowUpDate, Date taskFollowUpDateBefore, Date taskFollowUpDateAfter, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, String tenantIdIn, Boolean withoutTenantId, String taskVariables, String processVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String taskInvolvedUser, String taskInvolvedGroup, String taskHadCandidateUser, String taskHadCandidateGroup, Boolean withCandidateGroups, Boolean withoutCandidateGroups, ApiCallback<CountResultDto> _callback)Get Task Count (asynchronously) Queries for the number of historic tasks that fulfill the given parameters.okhttp3.CallgetHistoricTaskInstancesCountCall(String taskId, String taskParentTaskId, String processInstanceId, String processInstanceBusinessKey, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String executionId, String processDefinitionId, String processDefinitionKey, String processDefinitionName, String caseInstanceId, String caseExecutionId, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String activityInstanceIdIn, String taskName, String taskNameLike, String taskDescription, String taskDescriptionLike, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDeleteReason, String taskDeleteReasonLike, String taskAssignee, String taskAssigneeLike, String taskOwner, String taskOwnerLike, Integer taskPriority, Boolean assigned, Boolean unassigned, Boolean finished, Boolean unfinished, Boolean processFinished, Boolean processUnfinished, Date taskDueDate, Date taskDueDateBefore, Date taskDueDateAfter, Boolean withoutTaskDueDate, Date taskFollowUpDate, Date taskFollowUpDateBefore, Date taskFollowUpDateAfter, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, String tenantIdIn, Boolean withoutTenantId, String taskVariables, String processVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String taskInvolvedUser, String taskInvolvedGroup, String taskHadCandidateUser, String taskHadCandidateGroup, Boolean withCandidateGroups, Boolean withoutCandidateGroups, ApiCallback _callback)Build call for getHistoricTaskInstancesCountApiResponse<CountResultDto>getHistoricTaskInstancesCountWithHttpInfo(String taskId, String taskParentTaskId, String processInstanceId, String processInstanceBusinessKey, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String executionId, String processDefinitionId, String processDefinitionKey, String processDefinitionName, String caseInstanceId, String caseExecutionId, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String activityInstanceIdIn, String taskName, String taskNameLike, String taskDescription, String taskDescriptionLike, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDeleteReason, String taskDeleteReasonLike, String taskAssignee, String taskAssigneeLike, String taskOwner, String taskOwnerLike, Integer taskPriority, Boolean assigned, Boolean unassigned, Boolean finished, Boolean unfinished, Boolean processFinished, Boolean processUnfinished, Date taskDueDate, Date taskDueDateBefore, Date taskDueDateAfter, Boolean withoutTaskDueDate, Date taskFollowUpDate, Date taskFollowUpDateBefore, Date taskFollowUpDateAfter, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, String tenantIdIn, Boolean withoutTenantId, String taskVariables, String processVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String taskInvolvedUser, String taskInvolvedGroup, String taskHadCandidateUser, String taskHadCandidateGroup, Boolean withCandidateGroups, Boolean withoutCandidateGroups)Get Task Count Queries for the number of historic tasks that fulfill the given parameters.ApiResponse<List<HistoricTaskInstanceDto>>getHistoricTaskInstancesWithHttpInfo(String taskId, String taskParentTaskId, String processInstanceId, String processInstanceBusinessKey, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String executionId, String processDefinitionId, String processDefinitionKey, String processDefinitionName, String caseInstanceId, String caseExecutionId, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String activityInstanceIdIn, String taskName, String taskNameLike, String taskDescription, String taskDescriptionLike, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDeleteReason, String taskDeleteReasonLike, String taskAssignee, String taskAssigneeLike, String taskOwner, String taskOwnerLike, Integer taskPriority, Boolean assigned, Boolean unassigned, Boolean finished, Boolean unfinished, Boolean processFinished, Boolean processUnfinished, Date taskDueDate, Date taskDueDateBefore, Date taskDueDateAfter, Boolean withoutTaskDueDate, Date taskFollowUpDate, Date taskFollowUpDateBefore, Date taskFollowUpDateAfter, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, String tenantIdIn, Boolean withoutTenantId, String taskVariables, String processVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String taskInvolvedUser, String taskInvolvedGroup, String taskHadCandidateUser, String taskHadCandidateGroup, Boolean withCandidateGroups, Boolean withoutCandidateGroups, String sortBy, String sortOrder, Integer firstResult, Integer maxResults)Get Tasks (Historic) Queries for historic tasks that fulfill the given parameters.List<HistoricTaskInstanceDto>queryHistoricTaskInstances(Integer firstResult, Integer maxResults, HistoricTaskInstanceQueryDto historicTaskInstanceQueryDto)Get Tasks (Historic) (POST) Queries for historic tasks that fulfill the given parameters.okhttp3.CallqueryHistoricTaskInstancesAsync(Integer firstResult, Integer maxResults, HistoricTaskInstanceQueryDto historicTaskInstanceQueryDto, ApiCallback<List<HistoricTaskInstanceDto>> _callback)Get Tasks (Historic) (POST) (asynchronously) Queries for historic tasks that fulfill the given parameters.okhttp3.CallqueryHistoricTaskInstancesCall(Integer firstResult, Integer maxResults, HistoricTaskInstanceQueryDto historicTaskInstanceQueryDto, ApiCallback _callback)Build call for queryHistoricTaskInstancesCountResultDtoqueryHistoricTaskInstancesCount(HistoricTaskInstanceQueryDto historicTaskInstanceQueryDto)Get Task Count (POST) Queries for the number of historic tasks that fulfill the given parameters.okhttp3.CallqueryHistoricTaskInstancesCountAsync(HistoricTaskInstanceQueryDto historicTaskInstanceQueryDto, ApiCallback<CountResultDto> _callback)Get Task Count (POST) (asynchronously) Queries for the number of historic tasks that fulfill the given parameters.okhttp3.CallqueryHistoricTaskInstancesCountCall(HistoricTaskInstanceQueryDto historicTaskInstanceQueryDto, ApiCallback _callback)Build call for queryHistoricTaskInstancesCountApiResponse<CountResultDto>queryHistoricTaskInstancesCountWithHttpInfo(HistoricTaskInstanceQueryDto historicTaskInstanceQueryDto)Get Task Count (POST) Queries for the number of historic tasks that fulfill the given parameters.ApiResponse<List<HistoricTaskInstanceDto>>queryHistoricTaskInstancesWithHttpInfo(Integer firstResult, Integer maxResults, HistoricTaskInstanceQueryDto historicTaskInstanceQueryDto)Get Tasks (Historic) (POST) Queries for historic tasks that fulfill the given parameters.voidsetApiClient(ApiClient apiClient)
-
-
-
Constructor Detail
-
HistoricTaskInstanceApi
public HistoricTaskInstanceApi()
-
HistoricTaskInstanceApi
public HistoricTaskInstanceApi(ApiClient apiClient)
-
-
Method Detail
-
getApiClient
public ApiClient getApiClient()
-
setApiClient
public void setApiClient(ApiClient apiClient)
-
getHistoricTaskInstanceReportCall
public okhttp3.Call getHistoricTaskInstanceReportCall(String reportType, String periodUnit, Date completedBefore, Date completedAfter, String groupBy, ApiCallback _callback) throws ApiException
Build call for getHistoricTaskInstanceReport- Parameters:
reportType- **Mandatory.** Specifies the kind of the report to execute. To retrieve a report about the duration of process instances the value must be set to `duration`. For a report of the completed tasks in a specific timespan the value must be set to `count`. (optional)periodUnit- When the report type is set to `duration`, this parameter is **mandatory**. Specifies the granularity of the report. Valid values are `month` and `quarter`. (optional)completedBefore- Restrict to tasks that were completed 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.000+0200`. (optional)completedAfter- Restrict to tasks that were completed 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.000+0200`. (optional)groupBy- When the report type is set to `count`, this parameter is **mandatory**. Groups the tasks report by a given criterion. Valid values are `taskName` and `processDefinition`. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getHistoricTaskInstanceReport
public List<HistoricTaskInstanceReportResultDto> getHistoricTaskInstanceReport(String reportType, String periodUnit, Date completedBefore, Date completedAfter, String groupBy) throws ApiException
Get Task Report (Historic) Retrieves a report of completed tasks. When the report type is set to `count`, the report contains a list of completed task counts where an entry contains the task name, the definition key of the task, the process definition id, the process definition key, the process definition name and the count of how many tasks were completed for the specified key in a given period. When the report type is set to `duration`, the report contains a minimum, maximum and average duration value of all completed task instances in a given period.- Parameters:
reportType- **Mandatory.** Specifies the kind of the report to execute. To retrieve a report about the duration of process instances the value must be set to `duration`. For a report of the completed tasks in a specific timespan the value must be set to `count`. (optional)periodUnit- When the report type is set to `duration`, this parameter is **mandatory**. Specifies the granularity of the report. Valid values are `month` and `quarter`. (optional)completedBefore- Restrict to tasks that were completed 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.000+0200`. (optional)completedAfter- Restrict to tasks that were completed 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.000+0200`. (optional)groupBy- When the report type is set to `count`, this parameter is **mandatory**. Groups the tasks report by a given criterion. Valid values are `taskName` and `processDefinition`. (optional)- Returns:
- List<HistoricTaskInstanceReportResultDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getHistoricTaskInstanceReportWithHttpInfo
public ApiResponse<List<HistoricTaskInstanceReportResultDto>> getHistoricTaskInstanceReportWithHttpInfo(String reportType, String periodUnit, Date completedBefore, Date completedAfter, String groupBy) throws ApiException
Get Task Report (Historic) Retrieves a report of completed tasks. When the report type is set to `count`, the report contains a list of completed task counts where an entry contains the task name, the definition key of the task, the process definition id, the process definition key, the process definition name and the count of how many tasks were completed for the specified key in a given period. When the report type is set to `duration`, the report contains a minimum, maximum and average duration value of all completed task instances in a given period.- Parameters:
reportType- **Mandatory.** Specifies the kind of the report to execute. To retrieve a report about the duration of process instances the value must be set to `duration`. For a report of the completed tasks in a specific timespan the value must be set to `count`. (optional)periodUnit- When the report type is set to `duration`, this parameter is **mandatory**. Specifies the granularity of the report. Valid values are `month` and `quarter`. (optional)completedBefore- Restrict to tasks that were completed 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.000+0200`. (optional)completedAfter- Restrict to tasks that were completed 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.000+0200`. (optional)groupBy- When the report type is set to `count`, this parameter is **mandatory**. Groups the tasks report by a given criterion. Valid values are `taskName` and `processDefinition`. (optional)- Returns:
- ApiResponse<List<HistoricTaskInstanceReportResultDto>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getHistoricTaskInstanceReportAsync
public okhttp3.Call getHistoricTaskInstanceReportAsync(String reportType, String periodUnit, Date completedBefore, Date completedAfter, String groupBy, ApiCallback<List<HistoricTaskInstanceReportResultDto>> _callback) throws ApiException
Get Task Report (Historic) (asynchronously) Retrieves a report of completed tasks. When the report type is set to `count`, the report contains a list of completed task counts where an entry contains the task name, the definition key of the task, the process definition id, the process definition key, the process definition name and the count of how many tasks were completed for the specified key in a given period. When the report type is set to `duration`, the report contains a minimum, maximum and average duration value of all completed task instances in a given period.- Parameters:
reportType- **Mandatory.** Specifies the kind of the report to execute. To retrieve a report about the duration of process instances the value must be set to `duration`. For a report of the completed tasks in a specific timespan the value must be set to `count`. (optional)periodUnit- When the report type is set to `duration`, this parameter is **mandatory**. Specifies the granularity of the report. Valid values are `month` and `quarter`. (optional)completedBefore- Restrict to tasks that were completed 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.000+0200`. (optional)completedAfter- Restrict to tasks that were completed 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.000+0200`. (optional)groupBy- When the report type is set to `count`, this parameter is **mandatory**. Groups the tasks report by a given criterion. Valid values are `taskName` and `processDefinition`. (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
-
getHistoricTaskInstancesCall
public okhttp3.Call getHistoricTaskInstancesCall(String taskId, String taskParentTaskId, String processInstanceId, String processInstanceBusinessKey, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String executionId, String processDefinitionId, String processDefinitionKey, String processDefinitionName, String caseInstanceId, String caseExecutionId, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String activityInstanceIdIn, String taskName, String taskNameLike, String taskDescription, String taskDescriptionLike, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDeleteReason, String taskDeleteReasonLike, String taskAssignee, String taskAssigneeLike, String taskOwner, String taskOwnerLike, Integer taskPriority, Boolean assigned, Boolean unassigned, Boolean finished, Boolean unfinished, Boolean processFinished, Boolean processUnfinished, Date taskDueDate, Date taskDueDateBefore, Date taskDueDateAfter, Boolean withoutTaskDueDate, Date taskFollowUpDate, Date taskFollowUpDateBefore, Date taskFollowUpDateAfter, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, String tenantIdIn, Boolean withoutTenantId, String taskVariables, String processVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String taskInvolvedUser, String taskInvolvedGroup, String taskHadCandidateUser, String taskHadCandidateGroup, Boolean withCandidateGroups, Boolean withoutCandidateGroups, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, ApiCallback _callback) throws ApiException
Build call for getHistoricTaskInstances- Parameters:
taskId- Filter by task id. (optional)taskParentTaskId- Filter by parent task id. (optional)processInstanceId- Filter by process instance id. (optional)processInstanceBusinessKey- Filter by process instance business key. (optional)processInstanceBusinessKeyIn- Filter by process instances with one of the give business keys. The keys need to be in a comma-separated list. (optional)processInstanceBusinessKeyLike- Filter by process instance business key that has the parameter value as a substring. (optional)executionId- Filter by the id of the execution that executed the task. (optional)processDefinitionId- Filter by process definition id. (optional)processDefinitionKey- Restrict to tasks that belong to a process definition with the given key. (optional)processDefinitionName- Restrict to tasks that belong to a process definition with the given name. (optional)caseInstanceId- Filter by case instance id. (optional)caseExecutionId- Filter by the id of the case execution that executed the task. (optional)caseDefinitionId- Filter by case definition 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)activityInstanceIdIn- Only include tasks which belong to one of the passed comma-separated activity instance ids. (optional)taskName- Restrict to tasks that have the given name. (optional)taskNameLike- Restrict to tasks that have a name with the given parameter value as substring. (optional)taskDescription- Restrict to tasks that have the given description. (optional)taskDescriptionLike- Restrict to tasks that have a description that has the parameter value as a substring. (optional)taskDefinitionKey- Restrict to tasks that have the given key. (optional)taskDefinitionKeyIn- Restrict to tasks that have one of the passed comma-separated task definition keys. (optional)taskDeleteReason- Restrict to tasks that have the given delete reason. (optional)taskDeleteReasonLike- Restrict to tasks that have a delete reason that has the parameter value as a substring. (optional)taskAssignee- Restrict to tasks that the given user is assigned to. (optional)taskAssigneeLike- Restrict to tasks that are assigned to users with the parameter value as a substring. (optional)taskOwner- Restrict to tasks that the given user owns. (optional)taskOwnerLike- Restrict to tasks that are owned by users with the parameter value as a substring. (optional)taskPriority- Restrict to tasks that have the given priority. (optional)assigned- If set to `true`, restricts the query to all tasks that are assigned. (optional)unassigned- If set to `true`, restricts the query to all tasks that are unassigned. (optional)finished- Only include finished tasks. Value may only be `true`, as `false` is the default behavior. (optional)unfinished- Only include unfinished tasks. Value may only be `true`, as `false` is the default behavior. (optional)processFinished- Only include tasks of finished processes. Value may only be `true`, as `false` is the default behavior. (optional)processUnfinished- Only include tasks of unfinished processes. Value may only be `true`, as `false` is the default behavior. (optional)taskDueDate- 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.000+0200`. (optional)taskDueDateBefore- 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.000+0200`. (optional)taskDueDateAfter- 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.000+0200`. (optional)withoutTaskDueDate- Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional)taskFollowUpDate- 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.000+0200`. (optional)taskFollowUpDateBefore- 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.000+0200`. (optional)taskFollowUpDateAfter- 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.000+0200`. (optional)startedBefore- Restrict to tasks that were started 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.000+0200`. (optional)startedAfter- Restrict to tasks that were started 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.000+0200`. (optional)finishedBefore- Restrict to tasks that were finished 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.000+0200`. (optional)finishedAfter- Restrict to tasks that were finished 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.000+0200`. (optional)tenantIdIn- Filter by a comma-separated list of tenant ids. A task instance must have one of the given tenant ids. (optional)withoutTenantId- Only include historic task instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)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)variableNamesIgnoreCase- Match the variable name provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)variableValuesIgnoreCase- Match the variable value provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)taskInvolvedUser- Restrict to tasks with a historic identity link to the given user. (optional)taskInvolvedGroup- Restrict to tasks with a historic identity link to the given group. (optional)taskHadCandidateUser- Restrict to tasks with a historic identity link to the given candidate user. (optional)taskHadCandidateGroup- Restrict to tasks with a historic identity link to the given candidate group. (optional)withCandidateGroups- Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional)withoutCandidateGroups- Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (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
-
getHistoricTaskInstances
public List<HistoricTaskInstanceDto> getHistoricTaskInstances(String taskId, String taskParentTaskId, String processInstanceId, String processInstanceBusinessKey, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String executionId, String processDefinitionId, String processDefinitionKey, String processDefinitionName, String caseInstanceId, String caseExecutionId, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String activityInstanceIdIn, String taskName, String taskNameLike, String taskDescription, String taskDescriptionLike, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDeleteReason, String taskDeleteReasonLike, String taskAssignee, String taskAssigneeLike, String taskOwner, String taskOwnerLike, Integer taskPriority, Boolean assigned, Boolean unassigned, Boolean finished, Boolean unfinished, Boolean processFinished, Boolean processUnfinished, Date taskDueDate, Date taskDueDateBefore, Date taskDueDateAfter, Boolean withoutTaskDueDate, Date taskFollowUpDate, Date taskFollowUpDateBefore, Date taskFollowUpDateAfter, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, String tenantIdIn, Boolean withoutTenantId, String taskVariables, String processVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String taskInvolvedUser, String taskInvolvedGroup, String taskHadCandidateUser, String taskHadCandidateGroup, Boolean withCandidateGroups, Boolean withoutCandidateGroups, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) throws ApiException
Get Tasks (Historic) Queries for historic tasks that fulfill the given parameters. The size of the result set can be retrieved by using the [Get Task Count](https://docs.camunda.org/manual/7.18/reference/rest/history/task/get-task-query-count/) method.- Parameters:
taskId- Filter by task id. (optional)taskParentTaskId- Filter by parent task id. (optional)processInstanceId- Filter by process instance id. (optional)processInstanceBusinessKey- Filter by process instance business key. (optional)processInstanceBusinessKeyIn- Filter by process instances with one of the give business keys. The keys need to be in a comma-separated list. (optional)processInstanceBusinessKeyLike- Filter by process instance business key that has the parameter value as a substring. (optional)executionId- Filter by the id of the execution that executed the task. (optional)processDefinitionId- Filter by process definition id. (optional)processDefinitionKey- Restrict to tasks that belong to a process definition with the given key. (optional)processDefinitionName- Restrict to tasks that belong to a process definition with the given name. (optional)caseInstanceId- Filter by case instance id. (optional)caseExecutionId- Filter by the id of the case execution that executed the task. (optional)caseDefinitionId- Filter by case definition 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)activityInstanceIdIn- Only include tasks which belong to one of the passed comma-separated activity instance ids. (optional)taskName- Restrict to tasks that have the given name. (optional)taskNameLike- Restrict to tasks that have a name with the given parameter value as substring. (optional)taskDescription- Restrict to tasks that have the given description. (optional)taskDescriptionLike- Restrict to tasks that have a description that has the parameter value as a substring. (optional)taskDefinitionKey- Restrict to tasks that have the given key. (optional)taskDefinitionKeyIn- Restrict to tasks that have one of the passed comma-separated task definition keys. (optional)taskDeleteReason- Restrict to tasks that have the given delete reason. (optional)taskDeleteReasonLike- Restrict to tasks that have a delete reason that has the parameter value as a substring. (optional)taskAssignee- Restrict to tasks that the given user is assigned to. (optional)taskAssigneeLike- Restrict to tasks that are assigned to users with the parameter value as a substring. (optional)taskOwner- Restrict to tasks that the given user owns. (optional)taskOwnerLike- Restrict to tasks that are owned by users with the parameter value as a substring. (optional)taskPriority- Restrict to tasks that have the given priority. (optional)assigned- If set to `true`, restricts the query to all tasks that are assigned. (optional)unassigned- If set to `true`, restricts the query to all tasks that are unassigned. (optional)finished- Only include finished tasks. Value may only be `true`, as `false` is the default behavior. (optional)unfinished- Only include unfinished tasks. Value may only be `true`, as `false` is the default behavior. (optional)processFinished- Only include tasks of finished processes. Value may only be `true`, as `false` is the default behavior. (optional)processUnfinished- Only include tasks of unfinished processes. Value may only be `true`, as `false` is the default behavior. (optional)taskDueDate- 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.000+0200`. (optional)taskDueDateBefore- 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.000+0200`. (optional)taskDueDateAfter- 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.000+0200`. (optional)withoutTaskDueDate- Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional)taskFollowUpDate- 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.000+0200`. (optional)taskFollowUpDateBefore- 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.000+0200`. (optional)taskFollowUpDateAfter- 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.000+0200`. (optional)startedBefore- Restrict to tasks that were started 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.000+0200`. (optional)startedAfter- Restrict to tasks that were started 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.000+0200`. (optional)finishedBefore- Restrict to tasks that were finished 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.000+0200`. (optional)finishedAfter- Restrict to tasks that were finished 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.000+0200`. (optional)tenantIdIn- Filter by a comma-separated list of tenant ids. A task instance must have one of the given tenant ids. (optional)withoutTenantId- Only include historic task instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)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)variableNamesIgnoreCase- Match the variable name provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)variableValuesIgnoreCase- Match the variable value provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)taskInvolvedUser- Restrict to tasks with a historic identity link to the given user. (optional)taskInvolvedGroup- Restrict to tasks with a historic identity link to the given group. (optional)taskHadCandidateUser- Restrict to tasks with a historic identity link to the given candidate user. (optional)taskHadCandidateGroup- Restrict to tasks with a historic identity link to the given candidate group. (optional)withCandidateGroups- Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional)withoutCandidateGroups- Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (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<HistoricTaskInstanceDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getHistoricTaskInstancesWithHttpInfo
public ApiResponse<List<HistoricTaskInstanceDto>> getHistoricTaskInstancesWithHttpInfo(String taskId, String taskParentTaskId, String processInstanceId, String processInstanceBusinessKey, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String executionId, String processDefinitionId, String processDefinitionKey, String processDefinitionName, String caseInstanceId, String caseExecutionId, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String activityInstanceIdIn, String taskName, String taskNameLike, String taskDescription, String taskDescriptionLike, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDeleteReason, String taskDeleteReasonLike, String taskAssignee, String taskAssigneeLike, String taskOwner, String taskOwnerLike, Integer taskPriority, Boolean assigned, Boolean unassigned, Boolean finished, Boolean unfinished, Boolean processFinished, Boolean processUnfinished, Date taskDueDate, Date taskDueDateBefore, Date taskDueDateAfter, Boolean withoutTaskDueDate, Date taskFollowUpDate, Date taskFollowUpDateBefore, Date taskFollowUpDateAfter, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, String tenantIdIn, Boolean withoutTenantId, String taskVariables, String processVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String taskInvolvedUser, String taskInvolvedGroup, String taskHadCandidateUser, String taskHadCandidateGroup, Boolean withCandidateGroups, Boolean withoutCandidateGroups, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) throws ApiException
Get Tasks (Historic) Queries for historic tasks that fulfill the given parameters. The size of the result set can be retrieved by using the [Get Task Count](https://docs.camunda.org/manual/7.18/reference/rest/history/task/get-task-query-count/) method.- Parameters:
taskId- Filter by task id. (optional)taskParentTaskId- Filter by parent task id. (optional)processInstanceId- Filter by process instance id. (optional)processInstanceBusinessKey- Filter by process instance business key. (optional)processInstanceBusinessKeyIn- Filter by process instances with one of the give business keys. The keys need to be in a comma-separated list. (optional)processInstanceBusinessKeyLike- Filter by process instance business key that has the parameter value as a substring. (optional)executionId- Filter by the id of the execution that executed the task. (optional)processDefinitionId- Filter by process definition id. (optional)processDefinitionKey- Restrict to tasks that belong to a process definition with the given key. (optional)processDefinitionName- Restrict to tasks that belong to a process definition with the given name. (optional)caseInstanceId- Filter by case instance id. (optional)caseExecutionId- Filter by the id of the case execution that executed the task. (optional)caseDefinitionId- Filter by case definition 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)activityInstanceIdIn- Only include tasks which belong to one of the passed comma-separated activity instance ids. (optional)taskName- Restrict to tasks that have the given name. (optional)taskNameLike- Restrict to tasks that have a name with the given parameter value as substring. (optional)taskDescription- Restrict to tasks that have the given description. (optional)taskDescriptionLike- Restrict to tasks that have a description that has the parameter value as a substring. (optional)taskDefinitionKey- Restrict to tasks that have the given key. (optional)taskDefinitionKeyIn- Restrict to tasks that have one of the passed comma-separated task definition keys. (optional)taskDeleteReason- Restrict to tasks that have the given delete reason. (optional)taskDeleteReasonLike- Restrict to tasks that have a delete reason that has the parameter value as a substring. (optional)taskAssignee- Restrict to tasks that the given user is assigned to. (optional)taskAssigneeLike- Restrict to tasks that are assigned to users with the parameter value as a substring. (optional)taskOwner- Restrict to tasks that the given user owns. (optional)taskOwnerLike- Restrict to tasks that are owned by users with the parameter value as a substring. (optional)taskPriority- Restrict to tasks that have the given priority. (optional)assigned- If set to `true`, restricts the query to all tasks that are assigned. (optional)unassigned- If set to `true`, restricts the query to all tasks that are unassigned. (optional)finished- Only include finished tasks. Value may only be `true`, as `false` is the default behavior. (optional)unfinished- Only include unfinished tasks. Value may only be `true`, as `false` is the default behavior. (optional)processFinished- Only include tasks of finished processes. Value may only be `true`, as `false` is the default behavior. (optional)processUnfinished- Only include tasks of unfinished processes. Value may only be `true`, as `false` is the default behavior. (optional)taskDueDate- 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.000+0200`. (optional)taskDueDateBefore- 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.000+0200`. (optional)taskDueDateAfter- 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.000+0200`. (optional)withoutTaskDueDate- Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional)taskFollowUpDate- 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.000+0200`. (optional)taskFollowUpDateBefore- 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.000+0200`. (optional)taskFollowUpDateAfter- 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.000+0200`. (optional)startedBefore- Restrict to tasks that were started 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.000+0200`. (optional)startedAfter- Restrict to tasks that were started 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.000+0200`. (optional)finishedBefore- Restrict to tasks that were finished 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.000+0200`. (optional)finishedAfter- Restrict to tasks that were finished 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.000+0200`. (optional)tenantIdIn- Filter by a comma-separated list of tenant ids. A task instance must have one of the given tenant ids. (optional)withoutTenantId- Only include historic task instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)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)variableNamesIgnoreCase- Match the variable name provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)variableValuesIgnoreCase- Match the variable value provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)taskInvolvedUser- Restrict to tasks with a historic identity link to the given user. (optional)taskInvolvedGroup- Restrict to tasks with a historic identity link to the given group. (optional)taskHadCandidateUser- Restrict to tasks with a historic identity link to the given candidate user. (optional)taskHadCandidateGroup- Restrict to tasks with a historic identity link to the given candidate group. (optional)withCandidateGroups- Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional)withoutCandidateGroups- Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (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<HistoricTaskInstanceDto>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getHistoricTaskInstancesAsync
public okhttp3.Call getHistoricTaskInstancesAsync(String taskId, String taskParentTaskId, String processInstanceId, String processInstanceBusinessKey, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String executionId, String processDefinitionId, String processDefinitionKey, String processDefinitionName, String caseInstanceId, String caseExecutionId, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String activityInstanceIdIn, String taskName, String taskNameLike, String taskDescription, String taskDescriptionLike, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDeleteReason, String taskDeleteReasonLike, String taskAssignee, String taskAssigneeLike, String taskOwner, String taskOwnerLike, Integer taskPriority, Boolean assigned, Boolean unassigned, Boolean finished, Boolean unfinished, Boolean processFinished, Boolean processUnfinished, Date taskDueDate, Date taskDueDateBefore, Date taskDueDateAfter, Boolean withoutTaskDueDate, Date taskFollowUpDate, Date taskFollowUpDateBefore, Date taskFollowUpDateAfter, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, String tenantIdIn, Boolean withoutTenantId, String taskVariables, String processVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String taskInvolvedUser, String taskInvolvedGroup, String taskHadCandidateUser, String taskHadCandidateGroup, Boolean withCandidateGroups, Boolean withoutCandidateGroups, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, ApiCallback<List<HistoricTaskInstanceDto>> _callback) throws ApiException
Get Tasks (Historic) (asynchronously) Queries for historic tasks that fulfill the given parameters. The size of the result set can be retrieved by using the [Get Task Count](https://docs.camunda.org/manual/7.18/reference/rest/history/task/get-task-query-count/) method.- Parameters:
taskId- Filter by task id. (optional)taskParentTaskId- Filter by parent task id. (optional)processInstanceId- Filter by process instance id. (optional)processInstanceBusinessKey- Filter by process instance business key. (optional)processInstanceBusinessKeyIn- Filter by process instances with one of the give business keys. The keys need to be in a comma-separated list. (optional)processInstanceBusinessKeyLike- Filter by process instance business key that has the parameter value as a substring. (optional)executionId- Filter by the id of the execution that executed the task. (optional)processDefinitionId- Filter by process definition id. (optional)processDefinitionKey- Restrict to tasks that belong to a process definition with the given key. (optional)processDefinitionName- Restrict to tasks that belong to a process definition with the given name. (optional)caseInstanceId- Filter by case instance id. (optional)caseExecutionId- Filter by the id of the case execution that executed the task. (optional)caseDefinitionId- Filter by case definition 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)activityInstanceIdIn- Only include tasks which belong to one of the passed comma-separated activity instance ids. (optional)taskName- Restrict to tasks that have the given name. (optional)taskNameLike- Restrict to tasks that have a name with the given parameter value as substring. (optional)taskDescription- Restrict to tasks that have the given description. (optional)taskDescriptionLike- Restrict to tasks that have a description that has the parameter value as a substring. (optional)taskDefinitionKey- Restrict to tasks that have the given key. (optional)taskDefinitionKeyIn- Restrict to tasks that have one of the passed comma-separated task definition keys. (optional)taskDeleteReason- Restrict to tasks that have the given delete reason. (optional)taskDeleteReasonLike- Restrict to tasks that have a delete reason that has the parameter value as a substring. (optional)taskAssignee- Restrict to tasks that the given user is assigned to. (optional)taskAssigneeLike- Restrict to tasks that are assigned to users with the parameter value as a substring. (optional)taskOwner- Restrict to tasks that the given user owns. (optional)taskOwnerLike- Restrict to tasks that are owned by users with the parameter value as a substring. (optional)taskPriority- Restrict to tasks that have the given priority. (optional)assigned- If set to `true`, restricts the query to all tasks that are assigned. (optional)unassigned- If set to `true`, restricts the query to all tasks that are unassigned. (optional)finished- Only include finished tasks. Value may only be `true`, as `false` is the default behavior. (optional)unfinished- Only include unfinished tasks. Value may only be `true`, as `false` is the default behavior. (optional)processFinished- Only include tasks of finished processes. Value may only be `true`, as `false` is the default behavior. (optional)processUnfinished- Only include tasks of unfinished processes. Value may only be `true`, as `false` is the default behavior. (optional)taskDueDate- 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.000+0200`. (optional)taskDueDateBefore- 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.000+0200`. (optional)taskDueDateAfter- 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.000+0200`. (optional)withoutTaskDueDate- Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional)taskFollowUpDate- 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.000+0200`. (optional)taskFollowUpDateBefore- 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.000+0200`. (optional)taskFollowUpDateAfter- 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.000+0200`. (optional)startedBefore- Restrict to tasks that were started 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.000+0200`. (optional)startedAfter- Restrict to tasks that were started 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.000+0200`. (optional)finishedBefore- Restrict to tasks that were finished 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.000+0200`. (optional)finishedAfter- Restrict to tasks that were finished 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.000+0200`. (optional)tenantIdIn- Filter by a comma-separated list of tenant ids. A task instance must have one of the given tenant ids. (optional)withoutTenantId- Only include historic task instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)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)variableNamesIgnoreCase- Match the variable name provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)variableValuesIgnoreCase- Match the variable value provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)taskInvolvedUser- Restrict to tasks with a historic identity link to the given user. (optional)taskInvolvedGroup- Restrict to tasks with a historic identity link to the given group. (optional)taskHadCandidateUser- Restrict to tasks with a historic identity link to the given candidate user. (optional)taskHadCandidateGroup- Restrict to tasks with a historic identity link to the given candidate group. (optional)withCandidateGroups- Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional)withoutCandidateGroups- Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (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
-
getHistoricTaskInstancesCountCall
public okhttp3.Call getHistoricTaskInstancesCountCall(String taskId, String taskParentTaskId, String processInstanceId, String processInstanceBusinessKey, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String executionId, String processDefinitionId, String processDefinitionKey, String processDefinitionName, String caseInstanceId, String caseExecutionId, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String activityInstanceIdIn, String taskName, String taskNameLike, String taskDescription, String taskDescriptionLike, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDeleteReason, String taskDeleteReasonLike, String taskAssignee, String taskAssigneeLike, String taskOwner, String taskOwnerLike, Integer taskPriority, Boolean assigned, Boolean unassigned, Boolean finished, Boolean unfinished, Boolean processFinished, Boolean processUnfinished, Date taskDueDate, Date taskDueDateBefore, Date taskDueDateAfter, Boolean withoutTaskDueDate, Date taskFollowUpDate, Date taskFollowUpDateBefore, Date taskFollowUpDateAfter, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, String tenantIdIn, Boolean withoutTenantId, String taskVariables, String processVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String taskInvolvedUser, String taskInvolvedGroup, String taskHadCandidateUser, String taskHadCandidateGroup, Boolean withCandidateGroups, Boolean withoutCandidateGroups, ApiCallback _callback) throws ApiException
Build call for getHistoricTaskInstancesCount- Parameters:
taskId- Filter by task id. (optional)taskParentTaskId- Filter by parent task id. (optional)processInstanceId- Filter by process instance id. (optional)processInstanceBusinessKey- Filter by process instance business key. (optional)processInstanceBusinessKeyIn- Filter by process instances with one of the give business keys. The keys need to be in a comma-separated list. (optional)processInstanceBusinessKeyLike- Filter by process instance business key that has the parameter value as a substring. (optional)executionId- Filter by the id of the execution that executed the task. (optional)processDefinitionId- Filter by process definition id. (optional)processDefinitionKey- Restrict to tasks that belong to a process definition with the given key. (optional)processDefinitionName- Restrict to tasks that belong to a process definition with the given name. (optional)caseInstanceId- Filter by case instance id. (optional)caseExecutionId- Filter by the id of the case execution that executed the task. (optional)caseDefinitionId- Filter by case definition 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)activityInstanceIdIn- Only include tasks which belong to one of the passed comma-separated activity instance ids. (optional)taskName- Restrict to tasks that have the given name. (optional)taskNameLike- Restrict to tasks that have a name with the given parameter value as substring. (optional)taskDescription- Restrict to tasks that have the given description. (optional)taskDescriptionLike- Restrict to tasks that have a description that has the parameter value as a substring. (optional)taskDefinitionKey- Restrict to tasks that have the given key. (optional)taskDefinitionKeyIn- Restrict to tasks that have one of the passed comma-separated task definition keys. (optional)taskDeleteReason- Restrict to tasks that have the given delete reason. (optional)taskDeleteReasonLike- Restrict to tasks that have a delete reason that has the parameter value as a substring. (optional)taskAssignee- Restrict to tasks that the given user is assigned to. (optional)taskAssigneeLike- Restrict to tasks that are assigned to users with the parameter value as a substring. (optional)taskOwner- Restrict to tasks that the given user owns. (optional)taskOwnerLike- Restrict to tasks that are owned by users with the parameter value as a substring. (optional)taskPriority- Restrict to tasks that have the given priority. (optional)assigned- If set to `true`, restricts the query to all tasks that are assigned. (optional)unassigned- If set to `true`, restricts the query to all tasks that are unassigned. (optional)finished- Only include finished tasks. Value may only be `true`, as `false` is the default behavior. (optional)unfinished- Only include unfinished tasks. Value may only be `true`, as `false` is the default behavior. (optional)processFinished- Only include tasks of finished processes. Value may only be `true`, as `false` is the default behavior. (optional)processUnfinished- Only include tasks of unfinished processes. Value may only be `true`, as `false` is the default behavior. (optional)taskDueDate- 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.000+0200`. (optional)taskDueDateBefore- 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.000+0200`. (optional)taskDueDateAfter- 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.000+0200`. (optional)withoutTaskDueDate- Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional)taskFollowUpDate- 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.000+0200`. (optional)taskFollowUpDateBefore- 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.000+0200`. (optional)taskFollowUpDateAfter- 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.000+0200`. (optional)startedBefore- Restrict to tasks that were started 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.000+0200`. (optional)startedAfter- Restrict to tasks that were started 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.000+0200`. (optional)finishedBefore- Restrict to tasks that were finished 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.000+0200`. (optional)finishedAfter- Restrict to tasks that were finished 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.000+0200`. (optional)tenantIdIn- Filter by a comma-separated list of tenant ids. A task instance must have one of the given tenant ids. (optional)withoutTenantId- Only include historic task instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)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)variableNamesIgnoreCase- Match the variable name provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)variableValuesIgnoreCase- Match the variable value provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)taskInvolvedUser- Restrict to tasks with a historic identity link to the given user. (optional)taskInvolvedGroup- Restrict to tasks with a historic identity link to the given group. (optional)taskHadCandidateUser- Restrict to tasks with a historic identity link to the given candidate user. (optional)taskHadCandidateGroup- Restrict to tasks with a historic identity link to the given candidate group. (optional)withCandidateGroups- Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional)withoutCandidateGroups- Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
getHistoricTaskInstancesCount
public CountResultDto getHistoricTaskInstancesCount(String taskId, String taskParentTaskId, String processInstanceId, String processInstanceBusinessKey, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String executionId, String processDefinitionId, String processDefinitionKey, String processDefinitionName, String caseInstanceId, String caseExecutionId, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String activityInstanceIdIn, String taskName, String taskNameLike, String taskDescription, String taskDescriptionLike, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDeleteReason, String taskDeleteReasonLike, String taskAssignee, String taskAssigneeLike, String taskOwner, String taskOwnerLike, Integer taskPriority, Boolean assigned, Boolean unassigned, Boolean finished, Boolean unfinished, Boolean processFinished, Boolean processUnfinished, Date taskDueDate, Date taskDueDateBefore, Date taskDueDateAfter, Boolean withoutTaskDueDate, Date taskFollowUpDate, Date taskFollowUpDateBefore, Date taskFollowUpDateAfter, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, String tenantIdIn, Boolean withoutTenantId, String taskVariables, String processVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String taskInvolvedUser, String taskInvolvedGroup, String taskHadCandidateUser, String taskHadCandidateGroup, Boolean withCandidateGroups, Boolean withoutCandidateGroups) throws ApiException
Get Task Count Queries for the number of historic tasks that fulfill the given parameters. Takes the same parameters as the [Get Tasks (Historic)](https://docs.camunda.org/manual/7.18/reference/rest/history/task/get-task-query/) method.- Parameters:
taskId- Filter by task id. (optional)taskParentTaskId- Filter by parent task id. (optional)processInstanceId- Filter by process instance id. (optional)processInstanceBusinessKey- Filter by process instance business key. (optional)processInstanceBusinessKeyIn- Filter by process instances with one of the give business keys. The keys need to be in a comma-separated list. (optional)processInstanceBusinessKeyLike- Filter by process instance business key that has the parameter value as a substring. (optional)executionId- Filter by the id of the execution that executed the task. (optional)processDefinitionId- Filter by process definition id. (optional)processDefinitionKey- Restrict to tasks that belong to a process definition with the given key. (optional)processDefinitionName- Restrict to tasks that belong to a process definition with the given name. (optional)caseInstanceId- Filter by case instance id. (optional)caseExecutionId- Filter by the id of the case execution that executed the task. (optional)caseDefinitionId- Filter by case definition 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)activityInstanceIdIn- Only include tasks which belong to one of the passed comma-separated activity instance ids. (optional)taskName- Restrict to tasks that have the given name. (optional)taskNameLike- Restrict to tasks that have a name with the given parameter value as substring. (optional)taskDescription- Restrict to tasks that have the given description. (optional)taskDescriptionLike- Restrict to tasks that have a description that has the parameter value as a substring. (optional)taskDefinitionKey- Restrict to tasks that have the given key. (optional)taskDefinitionKeyIn- Restrict to tasks that have one of the passed comma-separated task definition keys. (optional)taskDeleteReason- Restrict to tasks that have the given delete reason. (optional)taskDeleteReasonLike- Restrict to tasks that have a delete reason that has the parameter value as a substring. (optional)taskAssignee- Restrict to tasks that the given user is assigned to. (optional)taskAssigneeLike- Restrict to tasks that are assigned to users with the parameter value as a substring. (optional)taskOwner- Restrict to tasks that the given user owns. (optional)taskOwnerLike- Restrict to tasks that are owned by users with the parameter value as a substring. (optional)taskPriority- Restrict to tasks that have the given priority. (optional)assigned- If set to `true`, restricts the query to all tasks that are assigned. (optional)unassigned- If set to `true`, restricts the query to all tasks that are unassigned. (optional)finished- Only include finished tasks. Value may only be `true`, as `false` is the default behavior. (optional)unfinished- Only include unfinished tasks. Value may only be `true`, as `false` is the default behavior. (optional)processFinished- Only include tasks of finished processes. Value may only be `true`, as `false` is the default behavior. (optional)processUnfinished- Only include tasks of unfinished processes. Value may only be `true`, as `false` is the default behavior. (optional)taskDueDate- 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.000+0200`. (optional)taskDueDateBefore- 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.000+0200`. (optional)taskDueDateAfter- 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.000+0200`. (optional)withoutTaskDueDate- Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional)taskFollowUpDate- 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.000+0200`. (optional)taskFollowUpDateBefore- 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.000+0200`. (optional)taskFollowUpDateAfter- 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.000+0200`. (optional)startedBefore- Restrict to tasks that were started 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.000+0200`. (optional)startedAfter- Restrict to tasks that were started 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.000+0200`. (optional)finishedBefore- Restrict to tasks that were finished 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.000+0200`. (optional)finishedAfter- Restrict to tasks that were finished 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.000+0200`. (optional)tenantIdIn- Filter by a comma-separated list of tenant ids. A task instance must have one of the given tenant ids. (optional)withoutTenantId- Only include historic task instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)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)variableNamesIgnoreCase- Match the variable name provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)variableValuesIgnoreCase- Match the variable value provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)taskInvolvedUser- Restrict to tasks with a historic identity link to the given user. (optional)taskInvolvedGroup- Restrict to tasks with a historic identity link to the given group. (optional)taskHadCandidateUser- Restrict to tasks with a historic identity link to the given candidate user. (optional)taskHadCandidateGroup- Restrict to tasks with a historic identity link to the given candidate group. (optional)withCandidateGroups- Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional)withoutCandidateGroups- Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (optional)- Returns:
- CountResultDto
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getHistoricTaskInstancesCountWithHttpInfo
public ApiResponse<CountResultDto> getHistoricTaskInstancesCountWithHttpInfo(String taskId, String taskParentTaskId, String processInstanceId, String processInstanceBusinessKey, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String executionId, String processDefinitionId, String processDefinitionKey, String processDefinitionName, String caseInstanceId, String caseExecutionId, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String activityInstanceIdIn, String taskName, String taskNameLike, String taskDescription, String taskDescriptionLike, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDeleteReason, String taskDeleteReasonLike, String taskAssignee, String taskAssigneeLike, String taskOwner, String taskOwnerLike, Integer taskPriority, Boolean assigned, Boolean unassigned, Boolean finished, Boolean unfinished, Boolean processFinished, Boolean processUnfinished, Date taskDueDate, Date taskDueDateBefore, Date taskDueDateAfter, Boolean withoutTaskDueDate, Date taskFollowUpDate, Date taskFollowUpDateBefore, Date taskFollowUpDateAfter, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, String tenantIdIn, Boolean withoutTenantId, String taskVariables, String processVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String taskInvolvedUser, String taskInvolvedGroup, String taskHadCandidateUser, String taskHadCandidateGroup, Boolean withCandidateGroups, Boolean withoutCandidateGroups) throws ApiException
Get Task Count Queries for the number of historic tasks that fulfill the given parameters. Takes the same parameters as the [Get Tasks (Historic)](https://docs.camunda.org/manual/7.18/reference/rest/history/task/get-task-query/) method.- Parameters:
taskId- Filter by task id. (optional)taskParentTaskId- Filter by parent task id. (optional)processInstanceId- Filter by process instance id. (optional)processInstanceBusinessKey- Filter by process instance business key. (optional)processInstanceBusinessKeyIn- Filter by process instances with one of the give business keys. The keys need to be in a comma-separated list. (optional)processInstanceBusinessKeyLike- Filter by process instance business key that has the parameter value as a substring. (optional)executionId- Filter by the id of the execution that executed the task. (optional)processDefinitionId- Filter by process definition id. (optional)processDefinitionKey- Restrict to tasks that belong to a process definition with the given key. (optional)processDefinitionName- Restrict to tasks that belong to a process definition with the given name. (optional)caseInstanceId- Filter by case instance id. (optional)caseExecutionId- Filter by the id of the case execution that executed the task. (optional)caseDefinitionId- Filter by case definition 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)activityInstanceIdIn- Only include tasks which belong to one of the passed comma-separated activity instance ids. (optional)taskName- Restrict to tasks that have the given name. (optional)taskNameLike- Restrict to tasks that have a name with the given parameter value as substring. (optional)taskDescription- Restrict to tasks that have the given description. (optional)taskDescriptionLike- Restrict to tasks that have a description that has the parameter value as a substring. (optional)taskDefinitionKey- Restrict to tasks that have the given key. (optional)taskDefinitionKeyIn- Restrict to tasks that have one of the passed comma-separated task definition keys. (optional)taskDeleteReason- Restrict to tasks that have the given delete reason. (optional)taskDeleteReasonLike- Restrict to tasks that have a delete reason that has the parameter value as a substring. (optional)taskAssignee- Restrict to tasks that the given user is assigned to. (optional)taskAssigneeLike- Restrict to tasks that are assigned to users with the parameter value as a substring. (optional)taskOwner- Restrict to tasks that the given user owns. (optional)taskOwnerLike- Restrict to tasks that are owned by users with the parameter value as a substring. (optional)taskPriority- Restrict to tasks that have the given priority. (optional)assigned- If set to `true`, restricts the query to all tasks that are assigned. (optional)unassigned- If set to `true`, restricts the query to all tasks that are unassigned. (optional)finished- Only include finished tasks. Value may only be `true`, as `false` is the default behavior. (optional)unfinished- Only include unfinished tasks. Value may only be `true`, as `false` is the default behavior. (optional)processFinished- Only include tasks of finished processes. Value may only be `true`, as `false` is the default behavior. (optional)processUnfinished- Only include tasks of unfinished processes. Value may only be `true`, as `false` is the default behavior. (optional)taskDueDate- 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.000+0200`. (optional)taskDueDateBefore- 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.000+0200`. (optional)taskDueDateAfter- 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.000+0200`. (optional)withoutTaskDueDate- Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional)taskFollowUpDate- 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.000+0200`. (optional)taskFollowUpDateBefore- 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.000+0200`. (optional)taskFollowUpDateAfter- 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.000+0200`. (optional)startedBefore- Restrict to tasks that were started 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.000+0200`. (optional)startedAfter- Restrict to tasks that were started 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.000+0200`. (optional)finishedBefore- Restrict to tasks that were finished 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.000+0200`. (optional)finishedAfter- Restrict to tasks that were finished 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.000+0200`. (optional)tenantIdIn- Filter by a comma-separated list of tenant ids. A task instance must have one of the given tenant ids. (optional)withoutTenantId- Only include historic task instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)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)variableNamesIgnoreCase- Match the variable name provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)variableValuesIgnoreCase- Match the variable value provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)taskInvolvedUser- Restrict to tasks with a historic identity link to the given user. (optional)taskInvolvedGroup- Restrict to tasks with a historic identity link to the given group. (optional)taskHadCandidateUser- Restrict to tasks with a historic identity link to the given candidate user. (optional)taskHadCandidateGroup- Restrict to tasks with a historic identity link to the given candidate group. (optional)withCandidateGroups- Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional)withoutCandidateGroups- Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (optional)- Returns:
- ApiResponse<CountResultDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getHistoricTaskInstancesCountAsync
public okhttp3.Call getHistoricTaskInstancesCountAsync(String taskId, String taskParentTaskId, String processInstanceId, String processInstanceBusinessKey, String processInstanceBusinessKeyIn, String processInstanceBusinessKeyLike, String executionId, String processDefinitionId, String processDefinitionKey, String processDefinitionName, String caseInstanceId, String caseExecutionId, String caseDefinitionId, String caseDefinitionKey, String caseDefinitionName, String activityInstanceIdIn, String taskName, String taskNameLike, String taskDescription, String taskDescriptionLike, String taskDefinitionKey, String taskDefinitionKeyIn, String taskDeleteReason, String taskDeleteReasonLike, String taskAssignee, String taskAssigneeLike, String taskOwner, String taskOwnerLike, Integer taskPriority, Boolean assigned, Boolean unassigned, Boolean finished, Boolean unfinished, Boolean processFinished, Boolean processUnfinished, Date taskDueDate, Date taskDueDateBefore, Date taskDueDateAfter, Boolean withoutTaskDueDate, Date taskFollowUpDate, Date taskFollowUpDateBefore, Date taskFollowUpDateAfter, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, String tenantIdIn, Boolean withoutTenantId, String taskVariables, String processVariables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, String taskInvolvedUser, String taskInvolvedGroup, String taskHadCandidateUser, String taskHadCandidateGroup, Boolean withCandidateGroups, Boolean withoutCandidateGroups, ApiCallback<CountResultDto> _callback) throws ApiException
Get Task Count (asynchronously) Queries for the number of historic tasks that fulfill the given parameters. Takes the same parameters as the [Get Tasks (Historic)](https://docs.camunda.org/manual/7.18/reference/rest/history/task/get-task-query/) method.- Parameters:
taskId- Filter by task id. (optional)taskParentTaskId- Filter by parent task id. (optional)processInstanceId- Filter by process instance id. (optional)processInstanceBusinessKey- Filter by process instance business key. (optional)processInstanceBusinessKeyIn- Filter by process instances with one of the give business keys. The keys need to be in a comma-separated list. (optional)processInstanceBusinessKeyLike- Filter by process instance business key that has the parameter value as a substring. (optional)executionId- Filter by the id of the execution that executed the task. (optional)processDefinitionId- Filter by process definition id. (optional)processDefinitionKey- Restrict to tasks that belong to a process definition with the given key. (optional)processDefinitionName- Restrict to tasks that belong to a process definition with the given name. (optional)caseInstanceId- Filter by case instance id. (optional)caseExecutionId- Filter by the id of the case execution that executed the task. (optional)caseDefinitionId- Filter by case definition 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)activityInstanceIdIn- Only include tasks which belong to one of the passed comma-separated activity instance ids. (optional)taskName- Restrict to tasks that have the given name. (optional)taskNameLike- Restrict to tasks that have a name with the given parameter value as substring. (optional)taskDescription- Restrict to tasks that have the given description. (optional)taskDescriptionLike- Restrict to tasks that have a description that has the parameter value as a substring. (optional)taskDefinitionKey- Restrict to tasks that have the given key. (optional)taskDefinitionKeyIn- Restrict to tasks that have one of the passed comma-separated task definition keys. (optional)taskDeleteReason- Restrict to tasks that have the given delete reason. (optional)taskDeleteReasonLike- Restrict to tasks that have a delete reason that has the parameter value as a substring. (optional)taskAssignee- Restrict to tasks that the given user is assigned to. (optional)taskAssigneeLike- Restrict to tasks that are assigned to users with the parameter value as a substring. (optional)taskOwner- Restrict to tasks that the given user owns. (optional)taskOwnerLike- Restrict to tasks that are owned by users with the parameter value as a substring. (optional)taskPriority- Restrict to tasks that have the given priority. (optional)assigned- If set to `true`, restricts the query to all tasks that are assigned. (optional)unassigned- If set to `true`, restricts the query to all tasks that are unassigned. (optional)finished- Only include finished tasks. Value may only be `true`, as `false` is the default behavior. (optional)unfinished- Only include unfinished tasks. Value may only be `true`, as `false` is the default behavior. (optional)processFinished- Only include tasks of finished processes. Value may only be `true`, as `false` is the default behavior. (optional)processUnfinished- Only include tasks of unfinished processes. Value may only be `true`, as `false` is the default behavior. (optional)taskDueDate- 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.000+0200`. (optional)taskDueDateBefore- 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.000+0200`. (optional)taskDueDateAfter- 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.000+0200`. (optional)withoutTaskDueDate- Only include tasks which have no due date. Value may only be `true`, as `false` is the default behavior. (optional)taskFollowUpDate- 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.000+0200`. (optional)taskFollowUpDateBefore- 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.000+0200`. (optional)taskFollowUpDateAfter- 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.000+0200`. (optional)startedBefore- Restrict to tasks that were started 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.000+0200`. (optional)startedAfter- Restrict to tasks that were started 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.000+0200`. (optional)finishedBefore- Restrict to tasks that were finished 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.000+0200`. (optional)finishedAfter- Restrict to tasks that were finished 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.000+0200`. (optional)tenantIdIn- Filter by a comma-separated list of tenant ids. A task instance must have one of the given tenant ids. (optional)withoutTenantId- Only include historic task instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)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)variableNamesIgnoreCase- Match the variable name provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)variableValuesIgnoreCase- Match the variable value provided in `taskVariables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)taskInvolvedUser- Restrict to tasks with a historic identity link to the given user. (optional)taskInvolvedGroup- Restrict to tasks with a historic identity link to the given group. (optional)taskHadCandidateUser- Restrict to tasks with a historic identity link to the given candidate user. (optional)taskHadCandidateGroup- Restrict to tasks with a historic identity link to the given candidate group. (optional)withCandidateGroups- Only include tasks which have a candidate group. Value may only be `true`, as `false` is the default behavior. (optional)withoutCandidateGroups- Only include tasks which have no candidate group. Value may only be `true`, as `false` is the default behavior. (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
-
queryHistoricTaskInstancesCall
public okhttp3.Call queryHistoricTaskInstancesCall(Integer firstResult, Integer maxResults, HistoricTaskInstanceQueryDto historicTaskInstanceQueryDto, ApiCallback _callback) throws ApiException
Build call for queryHistoricTaskInstances- 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)historicTaskInstanceQueryDto- (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
queryHistoricTaskInstances
public List<HistoricTaskInstanceDto> queryHistoricTaskInstances(Integer firstResult, Integer maxResults, HistoricTaskInstanceQueryDto historicTaskInstanceQueryDto) throws ApiException
Get Tasks (Historic) (POST) Queries for historic tasks that fulfill the given parameters. This method is slightly more powerful than the [Get Tasks (Historic)](https://docs.camunda.org/manual/7.18/reference/rest/history/task/get-task-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/history/task/post-task-query-count/) method.- 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)historicTaskInstanceQueryDto- (optional)- Returns:
- List<HistoricTaskInstanceDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
queryHistoricTaskInstancesWithHttpInfo
public ApiResponse<List<HistoricTaskInstanceDto>> queryHistoricTaskInstancesWithHttpInfo(Integer firstResult, Integer maxResults, HistoricTaskInstanceQueryDto historicTaskInstanceQueryDto) throws ApiException
Get Tasks (Historic) (POST) Queries for historic tasks that fulfill the given parameters. This method is slightly more powerful than the [Get Tasks (Historic)](https://docs.camunda.org/manual/7.18/reference/rest/history/task/get-task-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/history/task/post-task-query-count/) method.- 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)historicTaskInstanceQueryDto- (optional)- Returns:
- ApiResponse<List<HistoricTaskInstanceDto>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
queryHistoricTaskInstancesAsync
public okhttp3.Call queryHistoricTaskInstancesAsync(Integer firstResult, Integer maxResults, HistoricTaskInstanceQueryDto historicTaskInstanceQueryDto, ApiCallback<List<HistoricTaskInstanceDto>> _callback) throws ApiException
Get Tasks (Historic) (POST) (asynchronously) Queries for historic tasks that fulfill the given parameters. This method is slightly more powerful than the [Get Tasks (Historic)](https://docs.camunda.org/manual/7.18/reference/rest/history/task/get-task-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/history/task/post-task-query-count/) method.- 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)historicTaskInstanceQueryDto- (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
-
queryHistoricTaskInstancesCountCall
public okhttp3.Call queryHistoricTaskInstancesCountCall(HistoricTaskInstanceQueryDto historicTaskInstanceQueryDto, ApiCallback _callback) throws ApiException
Build call for queryHistoricTaskInstancesCount- Parameters:
historicTaskInstanceQueryDto- (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
queryHistoricTaskInstancesCount
public CountResultDto queryHistoricTaskInstancesCount(HistoricTaskInstanceQueryDto historicTaskInstanceQueryDto) throws ApiException
Get Task Count (POST) Queries for the number of historic tasks that fulfill the given parameters. Takes the same parameters as the [Get Tasks (Historic)](https://docs.camunda.org/manual/7.18/reference/rest/history/task/get-task-query/) method. Corresponds to the size of the result set of the [Get Tasks (Historic) (POST)](https://docs.camunda.org/manual/7.18/reference/rest/history/task/post-task-query/) method and takes the same parameters.- Parameters:
historicTaskInstanceQueryDto- (optional)- Returns:
- CountResultDto
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
queryHistoricTaskInstancesCountWithHttpInfo
public ApiResponse<CountResultDto> queryHistoricTaskInstancesCountWithHttpInfo(HistoricTaskInstanceQueryDto historicTaskInstanceQueryDto) throws ApiException
Get Task Count (POST) Queries for the number of historic tasks that fulfill the given parameters. Takes the same parameters as the [Get Tasks (Historic)](https://docs.camunda.org/manual/7.18/reference/rest/history/task/get-task-query/) method. Corresponds to the size of the result set of the [Get Tasks (Historic) (POST)](https://docs.camunda.org/manual/7.18/reference/rest/history/task/post-task-query/) method and takes the same parameters.- Parameters:
historicTaskInstanceQueryDto- (optional)- Returns:
- ApiResponse<CountResultDto>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
queryHistoricTaskInstancesCountAsync
public okhttp3.Call queryHistoricTaskInstancesCountAsync(HistoricTaskInstanceQueryDto historicTaskInstanceQueryDto, ApiCallback<CountResultDto> _callback) throws ApiException
Get Task Count (POST) (asynchronously) Queries for the number of historic tasks that fulfill the given parameters. Takes the same parameters as the [Get Tasks (Historic)](https://docs.camunda.org/manual/7.18/reference/rest/history/task/get-task-query/) method. Corresponds to the size of the result set of the [Get Tasks (Historic) (POST)](https://docs.camunda.org/manual/7.18/reference/rest/history/task/post-task-query/) method and takes the same parameters.- Parameters:
historicTaskInstanceQueryDto- (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
-
-