Package org.openapitools.client.api

Class HistoricProcessDefinitionApi

  • public class HistoricProcessDefinitionApi
extends Object

    • Constructor Detail

      • HistoricProcessDefinitionApi

        public HistoricProcessDefinitionApi()

      • HistoricProcessDefinitionApi

        public HistoricProcessDefinitionApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getCleanableHistoricProcessInstanceReportCall

        public okhttp3.Call getCleanableHistoricProcessInstanceReportCall​(String processDefinitionIdIn,
                                                                  String processDefinitionKeyIn,
                                                                  String tenantIdIn,
                                                                  Boolean withoutTenantId,
                                                                  Boolean compact,
                                                                  String sortBy,
                                                                  String sortOrder,
                                                                  Integer firstResult,
                                                                  Integer maxResults,
                                                                  ApiCallback _callback)
                                                           throws ApiException
        Build call for getCleanableHistoricProcessInstanceReport
        Parameters:
        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)
        tenantIdIn - Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids. (optional)
        withoutTenantId - Only include process definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        compact - Only include process instances which have more than zero finished instances. Value may only be `true`, as `false` is the default behavior. (optional)
        sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
        sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
        firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
        maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getCleanableHistoricProcessInstanceReport

        public List<CleanableHistoricProcessInstanceReportResultDto> getCleanableHistoricProcessInstanceReport​(String processDefinitionIdIn,
                                                                                                       String processDefinitionKeyIn,
                                                                                                       String tenantIdIn,
                                                                                                       Boolean withoutTenantId,
                                                                                                       Boolean compact,
                                                                                                       String sortBy,
                                                                                                       String sortOrder,
                                                                                                       Integer firstResult,
                                                                                                       Integer maxResults)
                                                                                                throws ApiException
        Get Cleanable Process Instance Report Retrieves a report about a process definition and finished process instances relevant to history cleanup (see [History cleanup](https://docs.camunda.org/manual/7.18/user-guide/process-engine/history/#history-cleanup)) so that you can tune the history time to live. These reports include the count of the finished historic process instances, cleanable process instances and basic process definition data - id, key, name and version. The size of the result set can be retrieved by using the [Get Cleanable Process Instance Report Count](https://docs.camunda.org/manual/7.18/reference/rest/history/process-definition/get-cleanable-process-instance-report-count/) method.
        Parameters:
        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)
        tenantIdIn - Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids. (optional)
        withoutTenantId - Only include process definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        compact - Only include process instances which have more than zero finished instances. Value may only be `true`, as `false` is the default behavior. (optional)
        sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
        sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
        firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
        maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
        Returns:
        List<CleanableHistoricProcessInstanceReportResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCleanableHistoricProcessInstanceReportWithHttpInfo

        public ApiResponse<List<CleanableHistoricProcessInstanceReportResultDto>> getCleanableHistoricProcessInstanceReportWithHttpInfo​(String processDefinitionIdIn,
                                                                                                                                String processDefinitionKeyIn,
                                                                                                                                String tenantIdIn,
                                                                                                                                Boolean withoutTenantId,
                                                                                                                                Boolean compact,
                                                                                                                                String sortBy,
                                                                                                                                String sortOrder,
                                                                                                                                Integer firstResult,
                                                                                                                                Integer maxResults)
                                                                                                                         throws ApiException
        Get Cleanable Process Instance Report Retrieves a report about a process definition and finished process instances relevant to history cleanup (see [History cleanup](https://docs.camunda.org/manual/7.18/user-guide/process-engine/history/#history-cleanup)) so that you can tune the history time to live. These reports include the count of the finished historic process instances, cleanable process instances and basic process definition data - id, key, name and version. The size of the result set can be retrieved by using the [Get Cleanable Process Instance Report Count](https://docs.camunda.org/manual/7.18/reference/rest/history/process-definition/get-cleanable-process-instance-report-count/) method.
        Parameters:
        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)
        tenantIdIn - Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids. (optional)
        withoutTenantId - Only include process definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        compact - Only include process instances which have more than zero finished instances. Value may only be `true`, as `false` is the default behavior. (optional)
        sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
        sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
        firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
        maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
        Returns:
        ApiResponse<List<CleanableHistoricProcessInstanceReportResultDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCleanableHistoricProcessInstanceReportAsync

        public okhttp3.Call getCleanableHistoricProcessInstanceReportAsync​(String processDefinitionIdIn,
                                                                   String processDefinitionKeyIn,
                                                                   String tenantIdIn,
                                                                   Boolean withoutTenantId,
                                                                   Boolean compact,
                                                                   String sortBy,
                                                                   String sortOrder,
                                                                   Integer firstResult,
                                                                   Integer maxResults,
                                                                   ApiCallback<List<CleanableHistoricProcessInstanceReportResultDto>> _callback)
                                                            throws ApiException
        Get Cleanable Process Instance Report (asynchronously) Retrieves a report about a process definition and finished process instances relevant to history cleanup (see [History cleanup](https://docs.camunda.org/manual/7.18/user-guide/process-engine/history/#history-cleanup)) so that you can tune the history time to live. These reports include the count of the finished historic process instances, cleanable process instances and basic process definition data - id, key, name and version. The size of the result set can be retrieved by using the [Get Cleanable Process Instance Report Count](https://docs.camunda.org/manual/7.18/reference/rest/history/process-definition/get-cleanable-process-instance-report-count/) method.
        Parameters:
        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)
        tenantIdIn - Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids. (optional)
        withoutTenantId - Only include process definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        compact - Only include process instances which have more than zero finished instances. Value may only be `true`, as `false` is the default behavior. (optional)
        sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
        sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
        firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
        maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getCleanableHistoricProcessInstanceReportCountCall

        public okhttp3.Call getCleanableHistoricProcessInstanceReportCountCall​(String processDefinitionIdIn,
                                                                       String processDefinitionKeyIn,
                                                                       String tenantIdIn,
                                                                       Boolean withoutTenantId,
                                                                       Boolean compact,
                                                                       ApiCallback _callback)
                                                                throws ApiException
        Build call for getCleanableHistoricProcessInstanceReportCount
        Parameters:
        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)
        tenantIdIn - Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids. (optional)
        withoutTenantId - Only include process definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        compact - Only include process instances which have more than zero finished instances. Value may only be `true`, as `false` is the default behavior. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getCleanableHistoricProcessInstanceReportCount

        public CountResultDto getCleanableHistoricProcessInstanceReportCount​(String processDefinitionIdIn,
                                                                     String processDefinitionKeyIn,
                                                                     String tenantIdIn,
                                                                     Boolean withoutTenantId,
                                                                     Boolean compact)
                                                              throws ApiException
        Get Cleanable Process Instance Report Count Queries for the number of report results about a process definition and finished process instances relevant to history cleanup (see [History cleanup](https://docs.camunda.org/manual/7.18/user-guide/process-engine/history/#history-cleanup)). Takes the same parameters as the [Get Cleanable Process Instance Report](https://docs.camunda.org/manual/7.18/reference/rest/history/process-definition/get-cleanable-process-instance-report/) method.
        Parameters:
        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)
        tenantIdIn - Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids. (optional)
        withoutTenantId - Only include process definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        compact - Only include process instances which have more than zero finished instances. Value may only be `true`, as `false` is the default behavior. (optional)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCleanableHistoricProcessInstanceReportCountWithHttpInfo

        public ApiResponse<CountResultDto> getCleanableHistoricProcessInstanceReportCountWithHttpInfo​(String processDefinitionIdIn,
                                                                                              String processDefinitionKeyIn,
                                                                                              String tenantIdIn,
                                                                                              Boolean withoutTenantId,
                                                                                              Boolean compact)
                                                                                       throws ApiException
        Get Cleanable Process Instance Report Count Queries for the number of report results about a process definition and finished process instances relevant to history cleanup (see [History cleanup](https://docs.camunda.org/manual/7.18/user-guide/process-engine/history/#history-cleanup)). Takes the same parameters as the [Get Cleanable Process Instance Report](https://docs.camunda.org/manual/7.18/reference/rest/history/process-definition/get-cleanable-process-instance-report/) method.
        Parameters:
        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)
        tenantIdIn - Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids. (optional)
        withoutTenantId - Only include process definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        compact - Only include process instances which have more than zero finished instances. Value may only be `true`, as `false` is the default behavior. (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getCleanableHistoricProcessInstanceReportCountAsync

        public okhttp3.Call getCleanableHistoricProcessInstanceReportCountAsync​(String processDefinitionIdIn,
                                                                        String processDefinitionKeyIn,
                                                                        String tenantIdIn,
                                                                        Boolean withoutTenantId,
                                                                        Boolean compact,
                                                                        ApiCallback<CountResultDto> _callback)
                                                                 throws ApiException
        Get Cleanable Process Instance Report Count (asynchronously) Queries for the number of report results about a process definition and finished process instances relevant to history cleanup (see [History cleanup](https://docs.camunda.org/manual/7.18/user-guide/process-engine/history/#history-cleanup)). Takes the same parameters as the [Get Cleanable Process Instance Report](https://docs.camunda.org/manual/7.18/reference/rest/history/process-definition/get-cleanable-process-instance-report/) method.
        Parameters:
        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)
        tenantIdIn - Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids. (optional)
        withoutTenantId - Only include process definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        compact - Only include process instances which have more than zero finished instances. Value may only be `true`, as `false` is the default behavior. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getHistoricActivityStatisticsCall

        public okhttp3.Call getHistoricActivityStatisticsCall​(String id,
                                                      Boolean canceled,
                                                      Boolean finished,
                                                      Boolean completeScope,
                                                      Boolean incidents,
                                                      Date startedBefore,
                                                      Date startedAfter,
                                                      Date finishedBefore,
                                                      Date finishedAfter,
                                                      String processInstanceIdIn,
                                                      String sortBy,
                                                      String sortOrder,
                                                      ApiCallback _callback)
                                               throws ApiException
        Build call for getHistoricActivityStatistics
        Parameters:
        id - The id of the process definition. (required)
        canceled - Whether to include the number of canceled activity instances in the result or not. Valid values are `true` or `false`. Default: `false`. (optional)
        finished - Whether to include the number of finished activity instances in the result or not. Valid values are `true` or `false`. Default: `false`. (optional)
        completeScope - Whether to include the number of activity instances which completed a scope in the result or not. Valid values are `true` or `false`. Default: `false`. (optional)
        incidents - Whether to include the number of incidents. Valid values are `true` or `false`. Default: `false`. (optional)
        startedBefore - Restrict to process instances that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Restrict to process instances that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        finishedBefore - Restrict to process instances that were finished before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        finishedAfter - Restrict to process instances that were finished after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        processInstanceIdIn - Restrict to process instances with the given IDs. The IDs must be provided as a comma- separated list. (optional)
        sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
        sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getHistoricActivityStatistics

        public List<HistoricActivityStatisticsDto> getHistoricActivityStatistics​(String id,
                                                                         Boolean canceled,
                                                                         Boolean finished,
                                                                         Boolean completeScope,
                                                                         Boolean incidents,
                                                                         Date startedBefore,
                                                                         Date startedAfter,
                                                                         Date finishedBefore,
                                                                         Date finishedAfter,
                                                                         String processInstanceIdIn,
                                                                         String sortBy,
                                                                         String sortOrder)
                                                                  throws ApiException
        Get Historic Activity Statistics Retrieves historic statistics of a given process definition, grouped by activities. These statistics include the number of running activity instances and, optionally, the number of canceled activity instances, finished activity instances and activity instances which completed a scope (i.e., in BPMN 2.0 manner: a scope is completed by an activity instance when the activity instance consumed a token but did not emit a new token). **Note:** This only includes historic data.
        Parameters:
        id - The id of the process definition. (required)
        canceled - Whether to include the number of canceled activity instances in the result or not. Valid values are `true` or `false`. Default: `false`. (optional)
        finished - Whether to include the number of finished activity instances in the result or not. Valid values are `true` or `false`. Default: `false`. (optional)
        completeScope - Whether to include the number of activity instances which completed a scope in the result or not. Valid values are `true` or `false`. Default: `false`. (optional)
        incidents - Whether to include the number of incidents. Valid values are `true` or `false`. Default: `false`. (optional)
        startedBefore - Restrict to process instances that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Restrict to process instances that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        finishedBefore - Restrict to process instances that were finished before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        finishedAfter - Restrict to process instances that were finished after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        processInstanceIdIn - Restrict to process instances with the given IDs. The IDs must be provided as a comma- separated list. (optional)
        sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
        sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
        Returns:
        List<HistoricActivityStatisticsDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricActivityStatisticsWithHttpInfo

        public ApiResponse<List<HistoricActivityStatisticsDto>> getHistoricActivityStatisticsWithHttpInfo​(String id,
                                                                                                  Boolean canceled,
                                                                                                  Boolean finished,
                                                                                                  Boolean completeScope,
                                                                                                  Boolean incidents,
                                                                                                  Date startedBefore,
                                                                                                  Date startedAfter,
                                                                                                  Date finishedBefore,
                                                                                                  Date finishedAfter,
                                                                                                  String processInstanceIdIn,
                                                                                                  String sortBy,
                                                                                                  String sortOrder)
                                                                                           throws ApiException
        Get Historic Activity Statistics Retrieves historic statistics of a given process definition, grouped by activities. These statistics include the number of running activity instances and, optionally, the number of canceled activity instances, finished activity instances and activity instances which completed a scope (i.e., in BPMN 2.0 manner: a scope is completed by an activity instance when the activity instance consumed a token but did not emit a new token). **Note:** This only includes historic data.
        Parameters:
        id - The id of the process definition. (required)
        canceled - Whether to include the number of canceled activity instances in the result or not. Valid values are `true` or `false`. Default: `false`. (optional)
        finished - Whether to include the number of finished activity instances in the result or not. Valid values are `true` or `false`. Default: `false`. (optional)
        completeScope - Whether to include the number of activity instances which completed a scope in the result or not. Valid values are `true` or `false`. Default: `false`. (optional)
        incidents - Whether to include the number of incidents. Valid values are `true` or `false`. Default: `false`. (optional)
        startedBefore - Restrict to process instances that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Restrict to process instances that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        finishedBefore - Restrict to process instances that were finished before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        finishedAfter - Restrict to process instances that were finished after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        processInstanceIdIn - Restrict to process instances with the given IDs. The IDs must be provided as a comma- separated list. (optional)
        sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
        sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
        Returns:
        ApiResponse<List<HistoricActivityStatisticsDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricActivityStatisticsAsync

        public okhttp3.Call getHistoricActivityStatisticsAsync​(String id,
                                                       Boolean canceled,
                                                       Boolean finished,
                                                       Boolean completeScope,
                                                       Boolean incidents,
                                                       Date startedBefore,
                                                       Date startedAfter,
                                                       Date finishedBefore,
                                                       Date finishedAfter,
                                                       String processInstanceIdIn,
                                                       String sortBy,
                                                       String sortOrder,
                                                       ApiCallback<List<HistoricActivityStatisticsDto>> _callback)
                                                throws ApiException
        Get Historic Activity Statistics (asynchronously) Retrieves historic statistics of a given process definition, grouped by activities. These statistics include the number of running activity instances and, optionally, the number of canceled activity instances, finished activity instances and activity instances which completed a scope (i.e., in BPMN 2.0 manner: a scope is completed by an activity instance when the activity instance consumed a token but did not emit a new token). **Note:** This only includes historic data.
        Parameters:
        id - The id of the process definition. (required)
        canceled - Whether to include the number of canceled activity instances in the result or not. Valid values are `true` or `false`. Default: `false`. (optional)
        finished - Whether to include the number of finished activity instances in the result or not. Valid values are `true` or `false`. Default: `false`. (optional)
        completeScope - Whether to include the number of activity instances which completed a scope in the result or not. Valid values are `true` or `false`. Default: `false`. (optional)
        incidents - Whether to include the number of incidents. Valid values are `true` or `false`. Default: `false`. (optional)
        startedBefore - Restrict to process instances that were started before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        startedAfter - Restrict to process instances that were started after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        finishedBefore - Restrict to process instances that were finished before the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        finishedAfter - Restrict to process instances that were finished after the given date. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the date must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., `2013-01-23T14:42:45.000+0200`. (optional)
        processInstanceIdIn - Restrict to process instances with the given IDs. The IDs must be provided as a comma- separated list. (optional)
        sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
        sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object