public class HistoricProcessInstanceApi extends Object
| Constructor and Description |
|---|
HistoricProcessInstanceApi() |
HistoricProcessInstanceApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
void |
deleteHistoricProcessInstance(String id,
Boolean failIfNotExists)
Delete
Deletes a process instance from the history by id.
|
okhttp3.Call |
deleteHistoricProcessInstanceAsync(String id,
Boolean failIfNotExists,
ApiCallback<Void> _callback)
Delete (asynchronously)
Deletes a process instance from the history by id.
|
okhttp3.Call |
deleteHistoricProcessInstanceCall(String id,
Boolean failIfNotExists,
ApiCallback _callback)
Build call for deleteHistoricProcessInstance
|
BatchDto |
deleteHistoricProcessInstancesAsync(DeleteHistoricProcessInstancesDto deleteHistoricProcessInstancesDto)
Delete Async (POST)
Delete multiple historic process instances asynchronously (batch).
|
okhttp3.Call |
deleteHistoricProcessInstancesAsyncAsync(DeleteHistoricProcessInstancesDto deleteHistoricProcessInstancesDto,
ApiCallback<BatchDto> _callback)
Delete Async (POST) (asynchronously)
Delete multiple historic process instances asynchronously (batch).
|
okhttp3.Call |
deleteHistoricProcessInstancesAsyncCall(DeleteHistoricProcessInstancesDto deleteHistoricProcessInstancesDto,
ApiCallback _callback)
Build call for deleteHistoricProcessInstancesAsync
|
ApiResponse<BatchDto> |
deleteHistoricProcessInstancesAsyncWithHttpInfo(DeleteHistoricProcessInstancesDto deleteHistoricProcessInstancesDto)
Delete Async (POST)
Delete multiple historic process instances asynchronously (batch).
|
ApiResponse<Void> |
deleteHistoricProcessInstanceWithHttpInfo(String id,
Boolean failIfNotExists)
Delete
Deletes a process instance from the history by id.
|
void |
deleteHistoricVariableInstancesOfHistoricProcessInstance(String id)
Delete Variable Instances
Deletes all variables of a process instance from the history by id.
|
okhttp3.Call |
deleteHistoricVariableInstancesOfHistoricProcessInstanceAsync(String id,
ApiCallback<Void> _callback)
Delete Variable Instances (asynchronously)
Deletes all variables of a process instance from the history by id.
|
okhttp3.Call |
deleteHistoricVariableInstancesOfHistoricProcessInstanceCall(String id,
ApiCallback _callback)
Build call for deleteHistoricVariableInstancesOfHistoricProcessInstance
|
ApiResponse<Void> |
deleteHistoricVariableInstancesOfHistoricProcessInstanceWithHttpInfo(String id)
Delete Variable Instances
Deletes all variables of a process instance from the history by id.
|
ApiClient |
getApiClient() |
HistoricProcessInstanceDto |
getHistoricProcessInstance(String id)
Get
Retrieves a historic process instance by id, according to the `HistoricProcessInstance` interface in the engine.
|
okhttp3.Call |
getHistoricProcessInstanceAsync(String id,
ApiCallback<HistoricProcessInstanceDto> _callback)
Get (asynchronously)
Retrieves a historic process instance by id, according to the `HistoricProcessInstance` interface in the engine.
|
okhttp3.Call |
getHistoricProcessInstanceCall(String id,
ApiCallback _callback)
Build call for getHistoricProcessInstance
|
List<DurationReportResultDto> |
getHistoricProcessInstanceDurationReport(String reportType,
String periodUnit,
String processDefinitionIdIn,
String processDefinitionKeyIn,
Date startedBefore,
Date startedAfter)
Get Duration Report
Retrieves a report about the duration of completed process instances, grouped by a period.
|
okhttp3.Call |
getHistoricProcessInstanceDurationReportAsync(String reportType,
String periodUnit,
String processDefinitionIdIn,
String processDefinitionKeyIn,
Date startedBefore,
Date startedAfter,
ApiCallback<List<DurationReportResultDto>> _callback)
Get Duration Report (asynchronously)
Retrieves a report about the duration of completed process instances, grouped by a period.
|
okhttp3.Call |
getHistoricProcessInstanceDurationReportCall(String reportType,
String periodUnit,
String processDefinitionIdIn,
String processDefinitionKeyIn,
Date startedBefore,
Date startedAfter,
ApiCallback _callback)
Build call for getHistoricProcessInstanceDurationReport
|
ApiResponse<List<DurationReportResultDto>> |
getHistoricProcessInstanceDurationReportWithHttpInfo(String reportType,
String periodUnit,
String processDefinitionIdIn,
String processDefinitionKeyIn,
Date startedBefore,
Date startedAfter)
Get Duration Report
Retrieves a report about the duration of completed process instances, grouped by a period.
|
List<HistoricProcessInstanceDto> |
getHistoricProcessInstances(String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults,
String processInstanceId,
String processInstanceIds,
String processDefinitionId,
String processDefinitionKey,
String processDefinitionKeyIn,
String processDefinitionName,
String processDefinitionNameLike,
String processDefinitionKeyNotIn,
String processInstanceBusinessKey,
String processInstanceBusinessKeyLike,
Boolean rootProcessInstances,
Boolean finished,
Boolean unfinished,
Boolean withIncidents,
Boolean withRootIncidents,
String incidentType,
String incidentStatus,
String incidentMessage,
String incidentMessageLike,
Date startedBefore,
Date startedAfter,
Date finishedBefore,
Date finishedAfter,
Date executedActivityAfter,
Date executedActivityBefore,
Date executedJobAfter,
Date executedJobBefore,
String startedBy,
String superProcessInstanceId,
String subProcessInstanceId,
String superCaseInstanceId,
String subCaseInstanceId,
String caseInstanceId,
String tenantIdIn,
Boolean withoutTenantId,
String executedActivityIdIn,
String activeActivityIdIn,
Boolean active,
Boolean suspended,
Boolean completed,
Boolean externallyTerminated,
Boolean internallyTerminated,
String variables,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase)
Get List
Queries for historic process instances that fulfill the given parameters.
|
okhttp3.Call |
getHistoricProcessInstancesAsync(String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults,
String processInstanceId,
String processInstanceIds,
String processDefinitionId,
String processDefinitionKey,
String processDefinitionKeyIn,
String processDefinitionName,
String processDefinitionNameLike,
String processDefinitionKeyNotIn,
String processInstanceBusinessKey,
String processInstanceBusinessKeyLike,
Boolean rootProcessInstances,
Boolean finished,
Boolean unfinished,
Boolean withIncidents,
Boolean withRootIncidents,
String incidentType,
String incidentStatus,
String incidentMessage,
String incidentMessageLike,
Date startedBefore,
Date startedAfter,
Date finishedBefore,
Date finishedAfter,
Date executedActivityAfter,
Date executedActivityBefore,
Date executedJobAfter,
Date executedJobBefore,
String startedBy,
String superProcessInstanceId,
String subProcessInstanceId,
String superCaseInstanceId,
String subCaseInstanceId,
String caseInstanceId,
String tenantIdIn,
Boolean withoutTenantId,
String executedActivityIdIn,
String activeActivityIdIn,
Boolean active,
Boolean suspended,
Boolean completed,
Boolean externallyTerminated,
Boolean internallyTerminated,
String variables,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase,
ApiCallback<List<HistoricProcessInstanceDto>> _callback)
Get List (asynchronously)
Queries for historic process instances that fulfill the given parameters.
|
okhttp3.Call |
getHistoricProcessInstancesCall(String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults,
String processInstanceId,
String processInstanceIds,
String processDefinitionId,
String processDefinitionKey,
String processDefinitionKeyIn,
String processDefinitionName,
String processDefinitionNameLike,
String processDefinitionKeyNotIn,
String processInstanceBusinessKey,
String processInstanceBusinessKeyLike,
Boolean rootProcessInstances,
Boolean finished,
Boolean unfinished,
Boolean withIncidents,
Boolean withRootIncidents,
String incidentType,
String incidentStatus,
String incidentMessage,
String incidentMessageLike,
Date startedBefore,
Date startedAfter,
Date finishedBefore,
Date finishedAfter,
Date executedActivityAfter,
Date executedActivityBefore,
Date executedJobAfter,
Date executedJobBefore,
String startedBy,
String superProcessInstanceId,
String subProcessInstanceId,
String superCaseInstanceId,
String subCaseInstanceId,
String caseInstanceId,
String tenantIdIn,
Boolean withoutTenantId,
String executedActivityIdIn,
String activeActivityIdIn,
Boolean active,
Boolean suspended,
Boolean completed,
Boolean externallyTerminated,
Boolean internallyTerminated,
String variables,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase,
ApiCallback _callback)
Build call for getHistoricProcessInstances
|
CountResultDto |
getHistoricProcessInstancesCount(String processInstanceId,
String processInstanceIds,
String processDefinitionId,
String processDefinitionKey,
String processDefinitionKeyIn,
String processDefinitionName,
String processDefinitionNameLike,
String processDefinitionKeyNotIn,
String processInstanceBusinessKey,
String processInstanceBusinessKeyLike,
Boolean rootProcessInstances,
Boolean finished,
Boolean unfinished,
Boolean withIncidents,
Boolean withRootIncidents,
String incidentType,
String incidentStatus,
String incidentMessage,
String incidentMessageLike,
Date startedBefore,
Date startedAfter,
Date finishedBefore,
Date finishedAfter,
Date executedActivityAfter,
Date executedActivityBefore,
Date executedJobAfter,
Date executedJobBefore,
String startedBy,
String superProcessInstanceId,
String subProcessInstanceId,
String superCaseInstanceId,
String subCaseInstanceId,
String caseInstanceId,
String tenantIdIn,
Boolean withoutTenantId,
String executedActivityIdIn,
String activeActivityIdIn,
Boolean active,
Boolean suspended,
Boolean completed,
Boolean externallyTerminated,
Boolean internallyTerminated,
String variables,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase)
Get List Count
Queries for the number of historic process instances that fulfill the given parameters.
|
okhttp3.Call |
getHistoricProcessInstancesCountAsync(String processInstanceId,
String processInstanceIds,
String processDefinitionId,
String processDefinitionKey,
String processDefinitionKeyIn,
String processDefinitionName,
String processDefinitionNameLike,
String processDefinitionKeyNotIn,
String processInstanceBusinessKey,
String processInstanceBusinessKeyLike,
Boolean rootProcessInstances,
Boolean finished,
Boolean unfinished,
Boolean withIncidents,
Boolean withRootIncidents,
String incidentType,
String incidentStatus,
String incidentMessage,
String incidentMessageLike,
Date startedBefore,
Date startedAfter,
Date finishedBefore,
Date finishedAfter,
Date executedActivityAfter,
Date executedActivityBefore,
Date executedJobAfter,
Date executedJobBefore,
String startedBy,
String superProcessInstanceId,
String subProcessInstanceId,
String superCaseInstanceId,
String subCaseInstanceId,
String caseInstanceId,
String tenantIdIn,
Boolean withoutTenantId,
String executedActivityIdIn,
String activeActivityIdIn,
Boolean active,
Boolean suspended,
Boolean completed,
Boolean externallyTerminated,
Boolean internallyTerminated,
String variables,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase,
ApiCallback<CountResultDto> _callback)
Get List Count (asynchronously)
Queries for the number of historic process instances that fulfill the given parameters.
|
okhttp3.Call |
getHistoricProcessInstancesCountCall(String processInstanceId,
String processInstanceIds,
String processDefinitionId,
String processDefinitionKey,
String processDefinitionKeyIn,
String processDefinitionName,
String processDefinitionNameLike,
String processDefinitionKeyNotIn,
String processInstanceBusinessKey,
String processInstanceBusinessKeyLike,
Boolean rootProcessInstances,
Boolean finished,
Boolean unfinished,
Boolean withIncidents,
Boolean withRootIncidents,
String incidentType,
String incidentStatus,
String incidentMessage,
String incidentMessageLike,
Date startedBefore,
Date startedAfter,
Date finishedBefore,
Date finishedAfter,
Date executedActivityAfter,
Date executedActivityBefore,
Date executedJobAfter,
Date executedJobBefore,
String startedBy,
String superProcessInstanceId,
String subProcessInstanceId,
String superCaseInstanceId,
String subCaseInstanceId,
String caseInstanceId,
String tenantIdIn,
Boolean withoutTenantId,
String executedActivityIdIn,
String activeActivityIdIn,
Boolean active,
Boolean suspended,
Boolean completed,
Boolean externallyTerminated,
Boolean internallyTerminated,
String variables,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase,
ApiCallback _callback)
Build call for getHistoricProcessInstancesCount
|
ApiResponse<CountResultDto> |
getHistoricProcessInstancesCountWithHttpInfo(String processInstanceId,
String processInstanceIds,
String processDefinitionId,
String processDefinitionKey,
String processDefinitionKeyIn,
String processDefinitionName,
String processDefinitionNameLike,
String processDefinitionKeyNotIn,
String processInstanceBusinessKey,
String processInstanceBusinessKeyLike,
Boolean rootProcessInstances,
Boolean finished,
Boolean unfinished,
Boolean withIncidents,
Boolean withRootIncidents,
String incidentType,
String incidentStatus,
String incidentMessage,
String incidentMessageLike,
Date startedBefore,
Date startedAfter,
Date finishedBefore,
Date finishedAfter,
Date executedActivityAfter,
Date executedActivityBefore,
Date executedJobAfter,
Date executedJobBefore,
String startedBy,
String superProcessInstanceId,
String subProcessInstanceId,
String superCaseInstanceId,
String subCaseInstanceId,
String caseInstanceId,
String tenantIdIn,
Boolean withoutTenantId,
String executedActivityIdIn,
String activeActivityIdIn,
Boolean active,
Boolean suspended,
Boolean completed,
Boolean externallyTerminated,
Boolean internallyTerminated,
String variables,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase)
Get List Count
Queries for the number of historic process instances that fulfill the given parameters.
|
ApiResponse<List<HistoricProcessInstanceDto>> |
getHistoricProcessInstancesWithHttpInfo(String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults,
String processInstanceId,
String processInstanceIds,
String processDefinitionId,
String processDefinitionKey,
String processDefinitionKeyIn,
String processDefinitionName,
String processDefinitionNameLike,
String processDefinitionKeyNotIn,
String processInstanceBusinessKey,
String processInstanceBusinessKeyLike,
Boolean rootProcessInstances,
Boolean finished,
Boolean unfinished,
Boolean withIncidents,
Boolean withRootIncidents,
String incidentType,
String incidentStatus,
String incidentMessage,
String incidentMessageLike,
Date startedBefore,
Date startedAfter,
Date finishedBefore,
Date finishedAfter,
Date executedActivityAfter,
Date executedActivityBefore,
Date executedJobAfter,
Date executedJobBefore,
String startedBy,
String superProcessInstanceId,
String subProcessInstanceId,
String superCaseInstanceId,
String subCaseInstanceId,
String caseInstanceId,
String tenantIdIn,
Boolean withoutTenantId,
String executedActivityIdIn,
String activeActivityIdIn,
Boolean active,
Boolean suspended,
Boolean completed,
Boolean externallyTerminated,
Boolean internallyTerminated,
String variables,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase)
Get List
Queries for historic process instances that fulfill the given parameters.
|
ApiResponse<HistoricProcessInstanceDto> |
getHistoricProcessInstanceWithHttpInfo(String id)
Get
Retrieves a historic process instance by id, according to the `HistoricProcessInstance` interface in the engine.
|
List<HistoricProcessInstanceDto> |
queryHistoricProcessInstances(Integer firstResult,
Integer maxResults,
HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto)
Get List (POST)
Queries for historic process instances that fulfill the given parameters.
|
okhttp3.Call |
queryHistoricProcessInstancesAsync(Integer firstResult,
Integer maxResults,
HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto,
ApiCallback<List<HistoricProcessInstanceDto>> _callback)
Get List (POST) (asynchronously)
Queries for historic process instances that fulfill the given parameters.
|
okhttp3.Call |
queryHistoricProcessInstancesCall(Integer firstResult,
Integer maxResults,
HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto,
ApiCallback _callback)
Build call for queryHistoricProcessInstances
|
CountResultDto |
queryHistoricProcessInstancesCount(HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto)
Get List Count (POST)
Queries for the number of historic process instances that fulfill the given parameters.
|
okhttp3.Call |
queryHistoricProcessInstancesCountAsync(HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto,
ApiCallback<CountResultDto> _callback)
Get List Count (POST) (asynchronously)
Queries for the number of historic process instances that fulfill the given parameters.
|
okhttp3.Call |
queryHistoricProcessInstancesCountCall(HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto,
ApiCallback _callback)
Build call for queryHistoricProcessInstancesCount
|
ApiResponse<CountResultDto> |
queryHistoricProcessInstancesCountWithHttpInfo(HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto)
Get List Count (POST)
Queries for the number of historic process instances that fulfill the given parameters.
|
ApiResponse<List<HistoricProcessInstanceDto>> |
queryHistoricProcessInstancesWithHttpInfo(Integer firstResult,
Integer maxResults,
HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto)
Get List (POST)
Queries for historic process instances that fulfill the given parameters.
|
void |
setApiClient(ApiClient apiClient) |
BatchDto |
setRemovalTimeAsync(SetRemovalTimeToHistoricProcessInstancesDto setRemovalTimeToHistoricProcessInstancesDto)
Set Removal Time Async (POST)
Sets the removal time to multiple historic process instances asynchronously (batch).
|
okhttp3.Call |
setRemovalTimeAsyncAsync(SetRemovalTimeToHistoricProcessInstancesDto setRemovalTimeToHistoricProcessInstancesDto,
ApiCallback<BatchDto> _callback)
Set Removal Time Async (POST) (asynchronously)
Sets the removal time to multiple historic process instances asynchronously (batch).
|
okhttp3.Call |
setRemovalTimeAsyncCall(SetRemovalTimeToHistoricProcessInstancesDto setRemovalTimeToHistoricProcessInstancesDto,
ApiCallback _callback)
Build call for setRemovalTimeAsync
|
ApiResponse<BatchDto> |
setRemovalTimeAsyncWithHttpInfo(SetRemovalTimeToHistoricProcessInstancesDto setRemovalTimeToHistoricProcessInstancesDto)
Set Removal Time Async (POST)
Sets the removal time to multiple historic process instances asynchronously (batch).
|
public HistoricProcessInstanceApi()
public HistoricProcessInstanceApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public okhttp3.Call deleteHistoricProcessInstanceCall(String id, Boolean failIfNotExists, ApiCallback _callback) throws ApiException
id - The id of the historic process instance to be deleted. (required)failIfNotExists - If set to `false`, the request will still be successful if the process id is not found. (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body objectpublic void deleteHistoricProcessInstance(String id, Boolean failIfNotExists) throws ApiException
id - The id of the historic process instance to be deleted. (required)failIfNotExists - If set to `false`, the request will still be successful if the process id is not found. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Void> deleteHistoricProcessInstanceWithHttpInfo(String id, Boolean failIfNotExists) throws ApiException
id - The id of the historic process instance to be deleted. (required)failIfNotExists - If set to `false`, the request will still be successful if the process id is not found. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call deleteHistoricProcessInstanceAsync(String id, Boolean failIfNotExists, ApiCallback<Void> _callback) throws ApiException
id - The id of the historic process instance to be deleted. (required)failIfNotExists - If set to `false`, the request will still be successful if the process id is not found. (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call deleteHistoricProcessInstancesAsyncCall(DeleteHistoricProcessInstancesDto deleteHistoricProcessInstancesDto, ApiCallback _callback) throws ApiException
deleteHistoricProcessInstancesDto - (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body objectpublic BatchDto deleteHistoricProcessInstancesAsync(DeleteHistoricProcessInstancesDto deleteHistoricProcessInstancesDto) throws ApiException
deleteHistoricProcessInstancesDto - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<BatchDto> deleteHistoricProcessInstancesAsyncWithHttpInfo(DeleteHistoricProcessInstancesDto deleteHistoricProcessInstancesDto) throws ApiException
deleteHistoricProcessInstancesDto - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call deleteHistoricProcessInstancesAsyncAsync(DeleteHistoricProcessInstancesDto deleteHistoricProcessInstancesDto, ApiCallback<BatchDto> _callback) throws ApiException
deleteHistoricProcessInstancesDto - (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call deleteHistoricVariableInstancesOfHistoricProcessInstanceCall(String id, ApiCallback _callback) throws ApiException
id - The id of the process instance for which all historic variables are to be deleted. (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body objectpublic void deleteHistoricVariableInstancesOfHistoricProcessInstance(String id) throws ApiException
id - The id of the process instance for which all historic variables are to be deleted. (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Void> deleteHistoricVariableInstancesOfHistoricProcessInstanceWithHttpInfo(String id) throws ApiException
id - The id of the process instance for which all historic variables are to be deleted. (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call deleteHistoricVariableInstancesOfHistoricProcessInstanceAsync(String id, ApiCallback<Void> _callback) throws ApiException
id - The id of the process instance for which all historic variables are to be deleted. (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call getHistoricProcessInstanceCall(String id, ApiCallback _callback) throws ApiException
id - The id of the historic process instance to be retrieved. (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body objectpublic HistoricProcessInstanceDto getHistoricProcessInstance(String id) throws ApiException
id - The id of the historic process instance to be retrieved. (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<HistoricProcessInstanceDto> getHistoricProcessInstanceWithHttpInfo(String id) throws ApiException
id - The id of the historic process instance to be retrieved. (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call getHistoricProcessInstanceAsync(String id, ApiCallback<HistoricProcessInstanceDto> _callback) throws ApiException
id - The id of the historic process instance to be retrieved. (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call getHistoricProcessInstanceDurationReportCall(String reportType, String periodUnit, String processDefinitionIdIn, String processDefinitionKeyIn, Date startedBefore, Date startedAfter, ApiCallback _callback) throws ApiException
reportType - **Mandatory.** Specifies the type of the report to retrieve. To retrieve a report about the duration of process instances, the value must be set to `duration`. (required)periodUnit - **Mandatory.** Specifies the granularity of the report. Valid values are `month` and `quarter`. (required)processDefinitionIdIn - Filter by process definition ids. Must be a comma-separated list of process definition ids. (optional)processDefinitionKeyIn - Filter by process definition keys. Must be a comma-separated list of process definition keys. (optional)startedBefore - Restrict to instances that were started before the given date. By [default](), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2016-01-23T14:42:45.000+0200`. (optional)startedAfter - Restrict to instances that were started after the given date. By [default](https://docs.camunda.org/manual/develop/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2016-01-23T14:42:45.000+0200`. (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body objectpublic List<DurationReportResultDto> getHistoricProcessInstanceDurationReport(String reportType, String periodUnit, String processDefinitionIdIn, String processDefinitionKeyIn, Date startedBefore, Date startedAfter) throws ApiException
reportType - **Mandatory.** Specifies the type of the report to retrieve. To retrieve a report about the duration of process instances, the value must be set to `duration`. (required)periodUnit - **Mandatory.** Specifies the granularity of the report. Valid values are `month` and `quarter`. (required)processDefinitionIdIn - Filter by process definition ids. Must be a comma-separated list of process definition ids. (optional)processDefinitionKeyIn - Filter by process definition keys. Must be a comma-separated list of process definition keys. (optional)startedBefore - Restrict to instances that were started before the given date. By [default](), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2016-01-23T14:42:45.000+0200`. (optional)startedAfter - Restrict to instances that were started after the given date. By [default](https://docs.camunda.org/manual/develop/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2016-01-23T14:42:45.000+0200`. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<List<DurationReportResultDto>> getHistoricProcessInstanceDurationReportWithHttpInfo(String reportType, String periodUnit, String processDefinitionIdIn, String processDefinitionKeyIn, Date startedBefore, Date startedAfter) throws ApiException
reportType - **Mandatory.** Specifies the type of the report to retrieve. To retrieve a report about the duration of process instances, the value must be set to `duration`. (required)periodUnit - **Mandatory.** Specifies the granularity of the report. Valid values are `month` and `quarter`. (required)processDefinitionIdIn - Filter by process definition ids. Must be a comma-separated list of process definition ids. (optional)processDefinitionKeyIn - Filter by process definition keys. Must be a comma-separated list of process definition keys. (optional)startedBefore - Restrict to instances that were started before the given date. By [default](), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2016-01-23T14:42:45.000+0200`. (optional)startedAfter - Restrict to instances that were started after the given date. By [default](https://docs.camunda.org/manual/develop/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2016-01-23T14:42:45.000+0200`. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call getHistoricProcessInstanceDurationReportAsync(String reportType, String periodUnit, String processDefinitionIdIn, String processDefinitionKeyIn, Date startedBefore, Date startedAfter, ApiCallback<List<DurationReportResultDto>> _callback) throws ApiException
reportType - **Mandatory.** Specifies the type of the report to retrieve. To retrieve a report about the duration of process instances, the value must be set to `duration`. (required)periodUnit - **Mandatory.** Specifies the granularity of the report. Valid values are `month` and `quarter`. (required)processDefinitionIdIn - Filter by process definition ids. Must be a comma-separated list of process definition ids. (optional)processDefinitionKeyIn - Filter by process definition keys. Must be a comma-separated list of process definition keys. (optional)startedBefore - Restrict to instances that were started before the given date. By [default](), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2016-01-23T14:42:45.000+0200`. (optional)startedAfter - Restrict to instances that were started after the given date. By [default](https://docs.camunda.org/manual/develop/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2016-01-23T14:42:45.000+0200`. (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call getHistoricProcessInstancesCall(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String processInstanceId, String processInstanceIds, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionName, String processDefinitionNameLike, String processDefinitionKeyNotIn, String processInstanceBusinessKey, String processInstanceBusinessKeyLike, Boolean rootProcessInstances, Boolean finished, Boolean unfinished, Boolean withIncidents, Boolean withRootIncidents, String incidentType, String incidentStatus, String incidentMessage, String incidentMessageLike, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, Date executedActivityAfter, Date executedActivityBefore, Date executedJobAfter, Date executedJobBefore, String startedBy, String superProcessInstanceId, String subProcessInstanceId, String superCaseInstanceId, String subCaseInstanceId, String caseInstanceId, String tenantIdIn, Boolean withoutTenantId, String executedActivityIdIn, String activeActivityIdIn, Boolean active, Boolean suspended, Boolean completed, Boolean externallyTerminated, Boolean internallyTerminated, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, ApiCallback _callback) throws ApiException
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)processInstanceId - Filter by process instance id. (optional)processInstanceIds - Filter by process instance ids. Filter by a comma-separated list of `Strings`. (optional)processDefinitionId - Filter by the process definition the instances run on. (optional)processDefinitionKey - Filter by the key of the process definition the instances run on. (optional)processDefinitionKeyIn - Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Filter by a comma-separated list of `Strings`. (optional)processDefinitionName - Filter by the name of the process definition the instances run on. (optional)processDefinitionNameLike - Filter by process definition names that the parameter is a substring of. (optional)processDefinitionKeyNotIn - Exclude instances that belong to a set of process definitions. Filter by a comma-separated list of `Strings`. (optional)processInstanceBusinessKey - Filter by process instance business key. (optional)processInstanceBusinessKeyLike - Filter by process instance business key that the parameter is a substring of. (optional)rootProcessInstances - Restrict the query to all process instances that are top level process instances. (optional)finished - Only include finished process instances. This flag includes all process instances that are completed or terminated. Value may only be `true`, as `false` is the default behavior. (optional)unfinished - Only include unfinished process instances. Value may only be `true`, as `false` is the default behavior. (optional)withIncidents - Only include process instances which have an incident. Value may only be `true`, as `false` is the default behavior. (optional)withRootIncidents - Only include process instances which have a root incident. Value may only be `true`, as `false` is the default behavior. (optional)incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)incidentStatus - Only include process instances which have an incident in status either open or resolved. To get all process instances, use the query parameter withIncidents. (optional)incidentMessage - Filter by the incident message. Exact match. (optional)incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)startedBefore - Restrict to instances that were started before the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were started after the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were finished before the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were finished after the given date. By [default](https://docs.camunda.org/manual/develop/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)executedActivityAfter - Restrict to instances that executed an activity after the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedActivityBefore - Restrict to instances that executed an activity before the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedJobAfter - Restrict to instances that executed an job after the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedJobBefore - Restrict to instances that executed an job before the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)startedBy - Only include process instances that were started by the given user. (optional)superProcessInstanceId - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)subProcessInstanceId - Restrict query to one process instance that has a sub process instance with the given id. (optional)superCaseInstanceId - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)subCaseInstanceId - Restrict query to one process instance that has a sub case instance with the given id. (optional)caseInstanceId - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)tenantIdIn - Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Filter by a comma-separated list of `Strings` (optional)withoutTenantId - Only include historic process instances which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)executedActivityIdIn - Restrict to instances that executed an activity with one of given ids. Filter by a comma-separated list of `Strings` (optional)activeActivityIdIn - Restrict to instances that have an active activity with one of given ids. Filter by a comma-separated list of `Strings` (optional)active - Restrict to instances that are active. (optional)suspended - Restrict to instances that are suspended. (optional)completed - Restrict to instances that are completed. (optional)externallyTerminated - Restrict to instances that are externallyTerminated. (optional)internallyTerminated - Restrict to instances that are internallyTerminated. (optional)variables - Only include process instances that have/had variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as String objects on server side. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. Key and value may not contain underscore or comma characters. (optional)variableNamesIgnoreCase - Match all variable names provided in variables case-insensitively. If set to `true` variableName and variablename are treated as equal. (optional)variableValuesIgnoreCase - Match all variable values provided in variables case-insensitively. If set to `true` variableValue and variablevalue are treated as equal. (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body objectpublic List<HistoricProcessInstanceDto> getHistoricProcessInstances(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String processInstanceId, String processInstanceIds, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionName, String processDefinitionNameLike, String processDefinitionKeyNotIn, String processInstanceBusinessKey, String processInstanceBusinessKeyLike, Boolean rootProcessInstances, Boolean finished, Boolean unfinished, Boolean withIncidents, Boolean withRootIncidents, String incidentType, String incidentStatus, String incidentMessage, String incidentMessageLike, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, Date executedActivityAfter, Date executedActivityBefore, Date executedJobAfter, Date executedJobBefore, String startedBy, String superProcessInstanceId, String subProcessInstanceId, String superCaseInstanceId, String subCaseInstanceId, String caseInstanceId, String tenantIdIn, Boolean withoutTenantId, String executedActivityIdIn, String activeActivityIdIn, Boolean active, Boolean suspended, Boolean completed, Boolean externallyTerminated, Boolean internallyTerminated, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase) throws ApiException
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)processInstanceId - Filter by process instance id. (optional)processInstanceIds - Filter by process instance ids. Filter by a comma-separated list of `Strings`. (optional)processDefinitionId - Filter by the process definition the instances run on. (optional)processDefinitionKey - Filter by the key of the process definition the instances run on. (optional)processDefinitionKeyIn - Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Filter by a comma-separated list of `Strings`. (optional)processDefinitionName - Filter by the name of the process definition the instances run on. (optional)processDefinitionNameLike - Filter by process definition names that the parameter is a substring of. (optional)processDefinitionKeyNotIn - Exclude instances that belong to a set of process definitions. Filter by a comma-separated list of `Strings`. (optional)processInstanceBusinessKey - Filter by process instance business key. (optional)processInstanceBusinessKeyLike - Filter by process instance business key that the parameter is a substring of. (optional)rootProcessInstances - Restrict the query to all process instances that are top level process instances. (optional)finished - Only include finished process instances. This flag includes all process instances that are completed or terminated. Value may only be `true`, as `false` is the default behavior. (optional)unfinished - Only include unfinished process instances. Value may only be `true`, as `false` is the default behavior. (optional)withIncidents - Only include process instances which have an incident. Value may only be `true`, as `false` is the default behavior. (optional)withRootIncidents - Only include process instances which have a root incident. Value may only be `true`, as `false` is the default behavior. (optional)incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)incidentStatus - Only include process instances which have an incident in status either open or resolved. To get all process instances, use the query parameter withIncidents. (optional)incidentMessage - Filter by the incident message. Exact match. (optional)incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)startedBefore - Restrict to instances that were started before the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were started after the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were finished before the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were finished after the given date. By [default](https://docs.camunda.org/manual/develop/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)executedActivityAfter - Restrict to instances that executed an activity after the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedActivityBefore - Restrict to instances that executed an activity before the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedJobAfter - Restrict to instances that executed an job after the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedJobBefore - Restrict to instances that executed an job before the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)startedBy - Only include process instances that were started by the given user. (optional)superProcessInstanceId - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)subProcessInstanceId - Restrict query to one process instance that has a sub process instance with the given id. (optional)superCaseInstanceId - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)subCaseInstanceId - Restrict query to one process instance that has a sub case instance with the given id. (optional)caseInstanceId - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)tenantIdIn - Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Filter by a comma-separated list of `Strings` (optional)withoutTenantId - Only include historic process instances which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)executedActivityIdIn - Restrict to instances that executed an activity with one of given ids. Filter by a comma-separated list of `Strings` (optional)activeActivityIdIn - Restrict to instances that have an active activity with one of given ids. Filter by a comma-separated list of `Strings` (optional)active - Restrict to instances that are active. (optional)suspended - Restrict to instances that are suspended. (optional)completed - Restrict to instances that are completed. (optional)externallyTerminated - Restrict to instances that are externallyTerminated. (optional)internallyTerminated - Restrict to instances that are internallyTerminated. (optional)variables - Only include process instances that have/had variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as String objects on server side. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. Key and value may not contain underscore or comma characters. (optional)variableNamesIgnoreCase - Match all variable names provided in variables case-insensitively. If set to `true` variableName and variablename are treated as equal. (optional)variableValuesIgnoreCase - Match all variable values provided in variables case-insensitively. If set to `true` variableValue and variablevalue are treated as equal. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<List<HistoricProcessInstanceDto>> getHistoricProcessInstancesWithHttpInfo(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String processInstanceId, String processInstanceIds, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionName, String processDefinitionNameLike, String processDefinitionKeyNotIn, String processInstanceBusinessKey, String processInstanceBusinessKeyLike, Boolean rootProcessInstances, Boolean finished, Boolean unfinished, Boolean withIncidents, Boolean withRootIncidents, String incidentType, String incidentStatus, String incidentMessage, String incidentMessageLike, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, Date executedActivityAfter, Date executedActivityBefore, Date executedJobAfter, Date executedJobBefore, String startedBy, String superProcessInstanceId, String subProcessInstanceId, String superCaseInstanceId, String subCaseInstanceId, String caseInstanceId, String tenantIdIn, Boolean withoutTenantId, String executedActivityIdIn, String activeActivityIdIn, Boolean active, Boolean suspended, Boolean completed, Boolean externallyTerminated, Boolean internallyTerminated, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase) throws ApiException
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)processInstanceId - Filter by process instance id. (optional)processInstanceIds - Filter by process instance ids. Filter by a comma-separated list of `Strings`. (optional)processDefinitionId - Filter by the process definition the instances run on. (optional)processDefinitionKey - Filter by the key of the process definition the instances run on. (optional)processDefinitionKeyIn - Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Filter by a comma-separated list of `Strings`. (optional)processDefinitionName - Filter by the name of the process definition the instances run on. (optional)processDefinitionNameLike - Filter by process definition names that the parameter is a substring of. (optional)processDefinitionKeyNotIn - Exclude instances that belong to a set of process definitions. Filter by a comma-separated list of `Strings`. (optional)processInstanceBusinessKey - Filter by process instance business key. (optional)processInstanceBusinessKeyLike - Filter by process instance business key that the parameter is a substring of. (optional)rootProcessInstances - Restrict the query to all process instances that are top level process instances. (optional)finished - Only include finished process instances. This flag includes all process instances that are completed or terminated. Value may only be `true`, as `false` is the default behavior. (optional)unfinished - Only include unfinished process instances. Value may only be `true`, as `false` is the default behavior. (optional)withIncidents - Only include process instances which have an incident. Value may only be `true`, as `false` is the default behavior. (optional)withRootIncidents - Only include process instances which have a root incident. Value may only be `true`, as `false` is the default behavior. (optional)incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)incidentStatus - Only include process instances which have an incident in status either open or resolved. To get all process instances, use the query parameter withIncidents. (optional)incidentMessage - Filter by the incident message. Exact match. (optional)incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)startedBefore - Restrict to instances that were started before the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were started after the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were finished before the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were finished after the given date. By [default](https://docs.camunda.org/manual/develop/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)executedActivityAfter - Restrict to instances that executed an activity after the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedActivityBefore - Restrict to instances that executed an activity before the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedJobAfter - Restrict to instances that executed an job after the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedJobBefore - Restrict to instances that executed an job before the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)startedBy - Only include process instances that were started by the given user. (optional)superProcessInstanceId - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)subProcessInstanceId - Restrict query to one process instance that has a sub process instance with the given id. (optional)superCaseInstanceId - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)subCaseInstanceId - Restrict query to one process instance that has a sub case instance with the given id. (optional)caseInstanceId - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)tenantIdIn - Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Filter by a comma-separated list of `Strings` (optional)withoutTenantId - Only include historic process instances which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)executedActivityIdIn - Restrict to instances that executed an activity with one of given ids. Filter by a comma-separated list of `Strings` (optional)activeActivityIdIn - Restrict to instances that have an active activity with one of given ids. Filter by a comma-separated list of `Strings` (optional)active - Restrict to instances that are active. (optional)suspended - Restrict to instances that are suspended. (optional)completed - Restrict to instances that are completed. (optional)externallyTerminated - Restrict to instances that are externallyTerminated. (optional)internallyTerminated - Restrict to instances that are internallyTerminated. (optional)variables - Only include process instances that have/had variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as String objects on server side. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. Key and value may not contain underscore or comma characters. (optional)variableNamesIgnoreCase - Match all variable names provided in variables case-insensitively. If set to `true` variableName and variablename are treated as equal. (optional)variableValuesIgnoreCase - Match all variable values provided in variables case-insensitively. If set to `true` variableValue and variablevalue are treated as equal. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call getHistoricProcessInstancesAsync(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String processInstanceId, String processInstanceIds, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionName, String processDefinitionNameLike, String processDefinitionKeyNotIn, String processInstanceBusinessKey, String processInstanceBusinessKeyLike, Boolean rootProcessInstances, Boolean finished, Boolean unfinished, Boolean withIncidents, Boolean withRootIncidents, String incidentType, String incidentStatus, String incidentMessage, String incidentMessageLike, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, Date executedActivityAfter, Date executedActivityBefore, Date executedJobAfter, Date executedJobBefore, String startedBy, String superProcessInstanceId, String subProcessInstanceId, String superCaseInstanceId, String subCaseInstanceId, String caseInstanceId, String tenantIdIn, Boolean withoutTenantId, String executedActivityIdIn, String activeActivityIdIn, Boolean active, Boolean suspended, Boolean completed, Boolean externallyTerminated, Boolean internallyTerminated, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, ApiCallback<List<HistoricProcessInstanceDto>> _callback) throws ApiException
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)processInstanceId - Filter by process instance id. (optional)processInstanceIds - Filter by process instance ids. Filter by a comma-separated list of `Strings`. (optional)processDefinitionId - Filter by the process definition the instances run on. (optional)processDefinitionKey - Filter by the key of the process definition the instances run on. (optional)processDefinitionKeyIn - Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Filter by a comma-separated list of `Strings`. (optional)processDefinitionName - Filter by the name of the process definition the instances run on. (optional)processDefinitionNameLike - Filter by process definition names that the parameter is a substring of. (optional)processDefinitionKeyNotIn - Exclude instances that belong to a set of process definitions. Filter by a comma-separated list of `Strings`. (optional)processInstanceBusinessKey - Filter by process instance business key. (optional)processInstanceBusinessKeyLike - Filter by process instance business key that the parameter is a substring of. (optional)rootProcessInstances - Restrict the query to all process instances that are top level process instances. (optional)finished - Only include finished process instances. This flag includes all process instances that are completed or terminated. Value may only be `true`, as `false` is the default behavior. (optional)unfinished - Only include unfinished process instances. Value may only be `true`, as `false` is the default behavior. (optional)withIncidents - Only include process instances which have an incident. Value may only be `true`, as `false` is the default behavior. (optional)withRootIncidents - Only include process instances which have a root incident. Value may only be `true`, as `false` is the default behavior. (optional)incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)incidentStatus - Only include process instances which have an incident in status either open or resolved. To get all process instances, use the query parameter withIncidents. (optional)incidentMessage - Filter by the incident message. Exact match. (optional)incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)startedBefore - Restrict to instances that were started before the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were started after the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were finished before the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were finished after the given date. By [default](https://docs.camunda.org/manual/develop/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)executedActivityAfter - Restrict to instances that executed an activity after the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedActivityBefore - Restrict to instances that executed an activity before the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedJobAfter - Restrict to instances that executed an job after the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedJobBefore - Restrict to instances that executed an job before the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)startedBy - Only include process instances that were started by the given user. (optional)superProcessInstanceId - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)subProcessInstanceId - Restrict query to one process instance that has a sub process instance with the given id. (optional)superCaseInstanceId - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)subCaseInstanceId - Restrict query to one process instance that has a sub case instance with the given id. (optional)caseInstanceId - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)tenantIdIn - Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Filter by a comma-separated list of `Strings` (optional)withoutTenantId - Only include historic process instances which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)executedActivityIdIn - Restrict to instances that executed an activity with one of given ids. Filter by a comma-separated list of `Strings` (optional)activeActivityIdIn - Restrict to instances that have an active activity with one of given ids. Filter by a comma-separated list of `Strings` (optional)active - Restrict to instances that are active. (optional)suspended - Restrict to instances that are suspended. (optional)completed - Restrict to instances that are completed. (optional)externallyTerminated - Restrict to instances that are externallyTerminated. (optional)internallyTerminated - Restrict to instances that are internallyTerminated. (optional)variables - Only include process instances that have/had variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as String objects on server side. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. Key and value may not contain underscore or comma characters. (optional)variableNamesIgnoreCase - Match all variable names provided in variables case-insensitively. If set to `true` variableName and variablename are treated as equal. (optional)variableValuesIgnoreCase - Match all variable values provided in variables case-insensitively. If set to `true` variableValue and variablevalue are treated as equal. (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call getHistoricProcessInstancesCountCall(String processInstanceId, String processInstanceIds, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionName, String processDefinitionNameLike, String processDefinitionKeyNotIn, String processInstanceBusinessKey, String processInstanceBusinessKeyLike, Boolean rootProcessInstances, Boolean finished, Boolean unfinished, Boolean withIncidents, Boolean withRootIncidents, String incidentType, String incidentStatus, String incidentMessage, String incidentMessageLike, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, Date executedActivityAfter, Date executedActivityBefore, Date executedJobAfter, Date executedJobBefore, String startedBy, String superProcessInstanceId, String subProcessInstanceId, String superCaseInstanceId, String subCaseInstanceId, String caseInstanceId, String tenantIdIn, Boolean withoutTenantId, String executedActivityIdIn, String activeActivityIdIn, Boolean active, Boolean suspended, Boolean completed, Boolean externallyTerminated, Boolean internallyTerminated, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, ApiCallback _callback) throws ApiException
processInstanceId - Filter by process instance id. (optional)processInstanceIds - Filter by process instance ids. Filter by a comma-separated list of `Strings`. (optional)processDefinitionId - Filter by the process definition the instances run on. (optional)processDefinitionKey - Filter by the key of the process definition the instances run on. (optional)processDefinitionKeyIn - Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Filter by a comma-separated list of `Strings`. (optional)processDefinitionName - Filter by the name of the process definition the instances run on. (optional)processDefinitionNameLike - Filter by process definition names that the parameter is a substring of. (optional)processDefinitionKeyNotIn - Exclude instances that belong to a set of process definitions. Filter by a comma-separated list of `Strings`. (optional)processInstanceBusinessKey - Filter by process instance business key. (optional)processInstanceBusinessKeyLike - Filter by process instance business key that the parameter is a substring of. (optional)rootProcessInstances - Restrict the query to all process instances that are top level process instances. (optional)finished - Only include finished process instances. This flag includes all process instances that are completed or terminated. Value may only be `true`, as `false` is the default behavior. (optional)unfinished - Only include unfinished process instances. Value may only be `true`, as `false` is the default behavior. (optional)withIncidents - Only include process instances which have an incident. Value may only be `true`, as `false` is the default behavior. (optional)withRootIncidents - Only include process instances which have a root incident. Value may only be `true`, as `false` is the default behavior. (optional)incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)incidentStatus - Only include process instances which have an incident in status either open or resolved. To get all process instances, use the query parameter withIncidents. (optional)incidentMessage - Filter by the incident message. Exact match. (optional)incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)startedBefore - Restrict to instances that were started before the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were started after the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were finished before the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were finished after the given date. By [default](https://docs.camunda.org/manual/develop/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)executedActivityAfter - Restrict to instances that executed an activity after the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedActivityBefore - Restrict to instances that executed an activity before the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedJobAfter - Restrict to instances that executed an job after the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedJobBefore - Restrict to instances that executed an job before the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)startedBy - Only include process instances that were started by the given user. (optional)superProcessInstanceId - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)subProcessInstanceId - Restrict query to one process instance that has a sub process instance with the given id. (optional)superCaseInstanceId - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)subCaseInstanceId - Restrict query to one process instance that has a sub case instance with the given id. (optional)caseInstanceId - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)tenantIdIn - Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Filter by a comma-separated list of `Strings` (optional)withoutTenantId - Only include historic process instances which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)executedActivityIdIn - Restrict to instances that executed an activity with one of given ids. Filter by a comma-separated list of `Strings` (optional)activeActivityIdIn - Restrict to instances that have an active activity with one of given ids. Filter by a comma-separated list of `Strings` (optional)active - Restrict to instances that are active. (optional)suspended - Restrict to instances that are suspended. (optional)completed - Restrict to instances that are completed. (optional)externallyTerminated - Restrict to instances that are externallyTerminated. (optional)internallyTerminated - Restrict to instances that are internallyTerminated. (optional)variables - Only include process instances that have/had variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as String objects on server side. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. Key and value may not contain underscore or comma characters. (optional)variableNamesIgnoreCase - Match all variable names provided in variables case-insensitively. If set to `true` variableName and variablename are treated as equal. (optional)variableValuesIgnoreCase - Match all variable values provided in variables case-insensitively. If set to `true` variableValue and variablevalue are treated as equal. (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body objectpublic CountResultDto getHistoricProcessInstancesCount(String processInstanceId, String processInstanceIds, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionName, String processDefinitionNameLike, String processDefinitionKeyNotIn, String processInstanceBusinessKey, String processInstanceBusinessKeyLike, Boolean rootProcessInstances, Boolean finished, Boolean unfinished, Boolean withIncidents, Boolean withRootIncidents, String incidentType, String incidentStatus, String incidentMessage, String incidentMessageLike, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, Date executedActivityAfter, Date executedActivityBefore, Date executedJobAfter, Date executedJobBefore, String startedBy, String superProcessInstanceId, String subProcessInstanceId, String superCaseInstanceId, String subCaseInstanceId, String caseInstanceId, String tenantIdIn, Boolean withoutTenantId, String executedActivityIdIn, String activeActivityIdIn, Boolean active, Boolean suspended, Boolean completed, Boolean externallyTerminated, Boolean internallyTerminated, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase) throws ApiException
processInstanceId - Filter by process instance id. (optional)processInstanceIds - Filter by process instance ids. Filter by a comma-separated list of `Strings`. (optional)processDefinitionId - Filter by the process definition the instances run on. (optional)processDefinitionKey - Filter by the key of the process definition the instances run on. (optional)processDefinitionKeyIn - Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Filter by a comma-separated list of `Strings`. (optional)processDefinitionName - Filter by the name of the process definition the instances run on. (optional)processDefinitionNameLike - Filter by process definition names that the parameter is a substring of. (optional)processDefinitionKeyNotIn - Exclude instances that belong to a set of process definitions. Filter by a comma-separated list of `Strings`. (optional)processInstanceBusinessKey - Filter by process instance business key. (optional)processInstanceBusinessKeyLike - Filter by process instance business key that the parameter is a substring of. (optional)rootProcessInstances - Restrict the query to all process instances that are top level process instances. (optional)finished - Only include finished process instances. This flag includes all process instances that are completed or terminated. Value may only be `true`, as `false` is the default behavior. (optional)unfinished - Only include unfinished process instances. Value may only be `true`, as `false` is the default behavior. (optional)withIncidents - Only include process instances which have an incident. Value may only be `true`, as `false` is the default behavior. (optional)withRootIncidents - Only include process instances which have a root incident. Value may only be `true`, as `false` is the default behavior. (optional)incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)incidentStatus - Only include process instances which have an incident in status either open or resolved. To get all process instances, use the query parameter withIncidents. (optional)incidentMessage - Filter by the incident message. Exact match. (optional)incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)startedBefore - Restrict to instances that were started before the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were started after the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were finished before the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were finished after the given date. By [default](https://docs.camunda.org/manual/develop/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)executedActivityAfter - Restrict to instances that executed an activity after the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedActivityBefore - Restrict to instances that executed an activity before the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedJobAfter - Restrict to instances that executed an job after the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedJobBefore - Restrict to instances that executed an job before the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)startedBy - Only include process instances that were started by the given user. (optional)superProcessInstanceId - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)subProcessInstanceId - Restrict query to one process instance that has a sub process instance with the given id. (optional)superCaseInstanceId - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)subCaseInstanceId - Restrict query to one process instance that has a sub case instance with the given id. (optional)caseInstanceId - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)tenantIdIn - Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Filter by a comma-separated list of `Strings` (optional)withoutTenantId - Only include historic process instances which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)executedActivityIdIn - Restrict to instances that executed an activity with one of given ids. Filter by a comma-separated list of `Strings` (optional)activeActivityIdIn - Restrict to instances that have an active activity with one of given ids. Filter by a comma-separated list of `Strings` (optional)active - Restrict to instances that are active. (optional)suspended - Restrict to instances that are suspended. (optional)completed - Restrict to instances that are completed. (optional)externallyTerminated - Restrict to instances that are externallyTerminated. (optional)internallyTerminated - Restrict to instances that are internallyTerminated. (optional)variables - Only include process instances that have/had variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as String objects on server side. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. Key and value may not contain underscore or comma characters. (optional)variableNamesIgnoreCase - Match all variable names provided in variables case-insensitively. If set to `true` variableName and variablename are treated as equal. (optional)variableValuesIgnoreCase - Match all variable values provided in variables case-insensitively. If set to `true` variableValue and variablevalue are treated as equal. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<CountResultDto> getHistoricProcessInstancesCountWithHttpInfo(String processInstanceId, String processInstanceIds, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionName, String processDefinitionNameLike, String processDefinitionKeyNotIn, String processInstanceBusinessKey, String processInstanceBusinessKeyLike, Boolean rootProcessInstances, Boolean finished, Boolean unfinished, Boolean withIncidents, Boolean withRootIncidents, String incidentType, String incidentStatus, String incidentMessage, String incidentMessageLike, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, Date executedActivityAfter, Date executedActivityBefore, Date executedJobAfter, Date executedJobBefore, String startedBy, String superProcessInstanceId, String subProcessInstanceId, String superCaseInstanceId, String subCaseInstanceId, String caseInstanceId, String tenantIdIn, Boolean withoutTenantId, String executedActivityIdIn, String activeActivityIdIn, Boolean active, Boolean suspended, Boolean completed, Boolean externallyTerminated, Boolean internallyTerminated, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase) throws ApiException
processInstanceId - Filter by process instance id. (optional)processInstanceIds - Filter by process instance ids. Filter by a comma-separated list of `Strings`. (optional)processDefinitionId - Filter by the process definition the instances run on. (optional)processDefinitionKey - Filter by the key of the process definition the instances run on. (optional)processDefinitionKeyIn - Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Filter by a comma-separated list of `Strings`. (optional)processDefinitionName - Filter by the name of the process definition the instances run on. (optional)processDefinitionNameLike - Filter by process definition names that the parameter is a substring of. (optional)processDefinitionKeyNotIn - Exclude instances that belong to a set of process definitions. Filter by a comma-separated list of `Strings`. (optional)processInstanceBusinessKey - Filter by process instance business key. (optional)processInstanceBusinessKeyLike - Filter by process instance business key that the parameter is a substring of. (optional)rootProcessInstances - Restrict the query to all process instances that are top level process instances. (optional)finished - Only include finished process instances. This flag includes all process instances that are completed or terminated. Value may only be `true`, as `false` is the default behavior. (optional)unfinished - Only include unfinished process instances. Value may only be `true`, as `false` is the default behavior. (optional)withIncidents - Only include process instances which have an incident. Value may only be `true`, as `false` is the default behavior. (optional)withRootIncidents - Only include process instances which have a root incident. Value may only be `true`, as `false` is the default behavior. (optional)incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)incidentStatus - Only include process instances which have an incident in status either open or resolved. To get all process instances, use the query parameter withIncidents. (optional)incidentMessage - Filter by the incident message. Exact match. (optional)incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)startedBefore - Restrict to instances that were started before the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were started after the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were finished before the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were finished after the given date. By [default](https://docs.camunda.org/manual/develop/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)executedActivityAfter - Restrict to instances that executed an activity after the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedActivityBefore - Restrict to instances that executed an activity before the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedJobAfter - Restrict to instances that executed an job after the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedJobBefore - Restrict to instances that executed an job before the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)startedBy - Only include process instances that were started by the given user. (optional)superProcessInstanceId - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)subProcessInstanceId - Restrict query to one process instance that has a sub process instance with the given id. (optional)superCaseInstanceId - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)subCaseInstanceId - Restrict query to one process instance that has a sub case instance with the given id. (optional)caseInstanceId - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)tenantIdIn - Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Filter by a comma-separated list of `Strings` (optional)withoutTenantId - Only include historic process instances which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)executedActivityIdIn - Restrict to instances that executed an activity with one of given ids. Filter by a comma-separated list of `Strings` (optional)activeActivityIdIn - Restrict to instances that have an active activity with one of given ids. Filter by a comma-separated list of `Strings` (optional)active - Restrict to instances that are active. (optional)suspended - Restrict to instances that are suspended. (optional)completed - Restrict to instances that are completed. (optional)externallyTerminated - Restrict to instances that are externallyTerminated. (optional)internallyTerminated - Restrict to instances that are internallyTerminated. (optional)variables - Only include process instances that have/had variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as String objects on server side. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. Key and value may not contain underscore or comma characters. (optional)variableNamesIgnoreCase - Match all variable names provided in variables case-insensitively. If set to `true` variableName and variablename are treated as equal. (optional)variableValuesIgnoreCase - Match all variable values provided in variables case-insensitively. If set to `true` variableValue and variablevalue are treated as equal. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call getHistoricProcessInstancesCountAsync(String processInstanceId, String processInstanceIds, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionName, String processDefinitionNameLike, String processDefinitionKeyNotIn, String processInstanceBusinessKey, String processInstanceBusinessKeyLike, Boolean rootProcessInstances, Boolean finished, Boolean unfinished, Boolean withIncidents, Boolean withRootIncidents, String incidentType, String incidentStatus, String incidentMessage, String incidentMessageLike, Date startedBefore, Date startedAfter, Date finishedBefore, Date finishedAfter, Date executedActivityAfter, Date executedActivityBefore, Date executedJobAfter, Date executedJobBefore, String startedBy, String superProcessInstanceId, String subProcessInstanceId, String superCaseInstanceId, String subCaseInstanceId, String caseInstanceId, String tenantIdIn, Boolean withoutTenantId, String executedActivityIdIn, String activeActivityIdIn, Boolean active, Boolean suspended, Boolean completed, Boolean externallyTerminated, Boolean internallyTerminated, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, ApiCallback<CountResultDto> _callback) throws ApiException
processInstanceId - Filter by process instance id. (optional)processInstanceIds - Filter by process instance ids. Filter by a comma-separated list of `Strings`. (optional)processDefinitionId - Filter by the process definition the instances run on. (optional)processDefinitionKey - Filter by the key of the process definition the instances run on. (optional)processDefinitionKeyIn - Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Filter by a comma-separated list of `Strings`. (optional)processDefinitionName - Filter by the name of the process definition the instances run on. (optional)processDefinitionNameLike - Filter by process definition names that the parameter is a substring of. (optional)processDefinitionKeyNotIn - Exclude instances that belong to a set of process definitions. Filter by a comma-separated list of `Strings`. (optional)processInstanceBusinessKey - Filter by process instance business key. (optional)processInstanceBusinessKeyLike - Filter by process instance business key that the parameter is a substring of. (optional)rootProcessInstances - Restrict the query to all process instances that are top level process instances. (optional)finished - Only include finished process instances. This flag includes all process instances that are completed or terminated. Value may only be `true`, as `false` is the default behavior. (optional)unfinished - Only include unfinished process instances. Value may only be `true`, as `false` is the default behavior. (optional)withIncidents - Only include process instances which have an incident. Value may only be `true`, as `false` is the default behavior. (optional)withRootIncidents - Only include process instances which have a root incident. Value may only be `true`, as `false` is the default behavior. (optional)incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/develop/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)incidentStatus - Only include process instances which have an incident in status either open or resolved. To get all process instances, use the query parameter withIncidents. (optional)incidentMessage - Filter by the incident message. Exact match. (optional)incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)startedBefore - Restrict to instances that were started before the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were started after the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were finished before the given date. By [default](https://docs.camunda.org/manual/develop/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 instances that were finished after the given date. By [default](https://docs.camunda.org/manual/develop/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)executedActivityAfter - Restrict to instances that executed an activity after the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedActivityBefore - Restrict to instances that executed an activity before the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedJobAfter - Restrict to instances that executed an job after the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)executedJobBefore - Restrict to instances that executed an job before the given date (inclusive). By [default](https://docs.camunda.org/manual/develop/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)startedBy - Only include process instances that were started by the given user. (optional)superProcessInstanceId - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)subProcessInstanceId - Restrict query to one process instance that has a sub process instance with the given id. (optional)superCaseInstanceId - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)subCaseInstanceId - Restrict query to one process instance that has a sub case instance with the given id. (optional)caseInstanceId - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)tenantIdIn - Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Filter by a comma-separated list of `Strings` (optional)withoutTenantId - Only include historic process instances which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)executedActivityIdIn - Restrict to instances that executed an activity with one of given ids. Filter by a comma-separated list of `Strings` (optional)activeActivityIdIn - Restrict to instances that have an active activity with one of given ids. Filter by a comma-separated list of `Strings` (optional)active - Restrict to instances that are active. (optional)suspended - Restrict to instances that are suspended. (optional)completed - Restrict to instances that are completed. (optional)externallyTerminated - Restrict to instances that are externallyTerminated. (optional)internallyTerminated - Restrict to instances that are internallyTerminated. (optional)variables - Only include process instances that have/had variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note:** Values are always treated as String objects on server side. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. Key and value may not contain underscore or comma characters. (optional)variableNamesIgnoreCase - Match all variable names provided in variables case-insensitively. If set to `true` variableName and variablename are treated as equal. (optional)variableValuesIgnoreCase - Match all variable values provided in variables case-insensitively. If set to `true` variableValue and variablevalue are treated as equal. (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call queryHistoricProcessInstancesCall(Integer firstResult, Integer maxResults, HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto, ApiCallback _callback) throws ApiException
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)historicProcessInstanceQueryDto - (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body objectpublic List<HistoricProcessInstanceDto> queryHistoricProcessInstances(Integer firstResult, Integer maxResults, HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto) throws ApiException
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)historicProcessInstanceQueryDto - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<List<HistoricProcessInstanceDto>> queryHistoricProcessInstancesWithHttpInfo(Integer firstResult, Integer maxResults, HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto) throws ApiException
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)historicProcessInstanceQueryDto - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call queryHistoricProcessInstancesAsync(Integer firstResult, Integer maxResults, HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto, ApiCallback<List<HistoricProcessInstanceDto>> _callback) throws ApiException
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)historicProcessInstanceQueryDto - (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call queryHistoricProcessInstancesCountCall(HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto, ApiCallback _callback) throws ApiException
historicProcessInstanceQueryDto - (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body objectpublic CountResultDto queryHistoricProcessInstancesCount(HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto) throws ApiException
historicProcessInstanceQueryDto - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<CountResultDto> queryHistoricProcessInstancesCountWithHttpInfo(HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto) throws ApiException
historicProcessInstanceQueryDto - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call queryHistoricProcessInstancesCountAsync(HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto, ApiCallback<CountResultDto> _callback) throws ApiException
historicProcessInstanceQueryDto - (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call setRemovalTimeAsyncCall(SetRemovalTimeToHistoricProcessInstancesDto setRemovalTimeToHistoricProcessInstancesDto, ApiCallback _callback) throws ApiException
setRemovalTimeToHistoricProcessInstancesDto - (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body objectpublic BatchDto setRemovalTimeAsync(SetRemovalTimeToHistoricProcessInstancesDto setRemovalTimeToHistoricProcessInstancesDto) throws ApiException
setRemovalTimeToHistoricProcessInstancesDto - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<BatchDto> setRemovalTimeAsyncWithHttpInfo(SetRemovalTimeToHistoricProcessInstancesDto setRemovalTimeToHistoricProcessInstancesDto) throws ApiException
setRemovalTimeToHistoricProcessInstancesDto - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call setRemovalTimeAsyncAsync(SetRemovalTimeToHistoricProcessInstancesDto setRemovalTimeToHistoricProcessInstancesDto, ApiCallback<BatchDto> _callback) throws ApiException
setRemovalTimeToHistoricProcessInstancesDto - (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectCopyright © 2021. All rights reserved.