Package org.openapitools.client.api

Class HistoricDetailApi

  • public class HistoricDetailApi
extends Object

    • Constructor Detail

      • HistoricDetailApi

        public HistoricDetailApi()

      • HistoricDetailApi

        public HistoricDetailApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getHistoricDetailsCall

        public okhttp3.Call getHistoricDetailsCall​(String processInstanceId,
                                           String processInstanceIdIn,
                                           String executionId,
                                           String taskId,
                                           String activityInstanceId,
                                           String caseInstanceId,
                                           String caseExecutionId,
                                           String variableInstanceId,
                                           String variableTypeIn,
                                           String tenantIdIn,
                                           Boolean withoutTenantId,
                                           String userOperationId,
                                           Boolean formFields,
                                           Boolean variableUpdates,
                                           Boolean excludeTaskDetails,
                                           Boolean initial,
                                           Date occurredBefore,
                                           Date occurredAfter,
                                           String sortBy,
                                           String sortOrder,
                                           Integer firstResult,
                                           Integer maxResults,
                                           Boolean deserializeValues,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for getHistoricDetails
        Parameters:
        processInstanceId - Filter by process instance id. (optional)
        processInstanceIdIn - Only include historic details which belong to one of the passed comma-separated process instance ids. (optional)
        executionId - Filter by execution id. (optional)
        taskId - Filter by task id. (optional)
        activityInstanceId - Filter by activity instance id. (optional)
        caseInstanceId - Filter by case instance id. (optional)
        caseExecutionId - Filter by case execution id. (optional)
        variableInstanceId - Filter by variable instance id. (optional)
        variableTypeIn - Only include historic details where the variable updates belong to one of the passed comma-separated list of variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type `serializable`. (optional)
        tenantIdIn - Filter by a comma-separated list of tenant ids. (optional)
        withoutTenantId - Only include historic details that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        userOperationId - Filter by a user operation id. (optional)
        formFields - Only include `HistoricFormFields`. Value may only be `true`, as `false` is the default behavior. (optional)
        variableUpdates - Only include `HistoricVariableUpdates`. Value may only be `true`, as `false` is the default behavior. (optional)
        excludeTaskDetails - Excludes all task-related `HistoricDetails`, so only items which have no task id set will be selected. When this parameter is used together with `taskId`, this call is ignored and task details are not excluded. Value may only be `true`, as `false` is the default behavior. (optional)
        initial - Restrict to historic variable updates that contain only initial variable values. Value may only be `true`, as `false` is the default behavior. (optional)
        occurredBefore - Restrict to historic details that occured before the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        occurredAfter - Restrict to historic details that occured after the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (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)
        deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getHistoricDetails

        public List<HistoricDetailDto> getHistoricDetails​(String processInstanceId,
                                                  String processInstanceIdIn,
                                                  String executionId,
                                                  String taskId,
                                                  String activityInstanceId,
                                                  String caseInstanceId,
                                                  String caseExecutionId,
                                                  String variableInstanceId,
                                                  String variableTypeIn,
                                                  String tenantIdIn,
                                                  Boolean withoutTenantId,
                                                  String userOperationId,
                                                  Boolean formFields,
                                                  Boolean variableUpdates,
                                                  Boolean excludeTaskDetails,
                                                  Boolean initial,
                                                  Date occurredBefore,
                                                  Date occurredAfter,
                                                  String sortBy,
                                                  String sortOrder,
                                                  Integer firstResult,
                                                  Integer maxResults,
                                                  Boolean deserializeValues)
                                           throws ApiException
        Get Historic Details Queries for historic details that fulfill the given parameters. The size of the result set can be retrieved by using the [Get Historic Detail Count](https://docs.camunda.org/manual/7.18/reference/rest/history/detail/get-detail-query-count/) method.
        Parameters:
        processInstanceId - Filter by process instance id. (optional)
        processInstanceIdIn - Only include historic details which belong to one of the passed comma-separated process instance ids. (optional)
        executionId - Filter by execution id. (optional)
        taskId - Filter by task id. (optional)
        activityInstanceId - Filter by activity instance id. (optional)
        caseInstanceId - Filter by case instance id. (optional)
        caseExecutionId - Filter by case execution id. (optional)
        variableInstanceId - Filter by variable instance id. (optional)
        variableTypeIn - Only include historic details where the variable updates belong to one of the passed comma-separated list of variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type `serializable`. (optional)
        tenantIdIn - Filter by a comma-separated list of tenant ids. (optional)
        withoutTenantId - Only include historic details that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        userOperationId - Filter by a user operation id. (optional)
        formFields - Only include `HistoricFormFields`. Value may only be `true`, as `false` is the default behavior. (optional)
        variableUpdates - Only include `HistoricVariableUpdates`. Value may only be `true`, as `false` is the default behavior. (optional)
        excludeTaskDetails - Excludes all task-related `HistoricDetails`, so only items which have no task id set will be selected. When this parameter is used together with `taskId`, this call is ignored and task details are not excluded. Value may only be `true`, as `false` is the default behavior. (optional)
        initial - Restrict to historic variable updates that contain only initial variable values. Value may only be `true`, as `false` is the default behavior. (optional)
        occurredBefore - Restrict to historic details that occured before the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        occurredAfter - Restrict to historic details that occured after the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (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)
        deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        Returns:
        List<HistoricDetailDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricDetailsWithHttpInfo

        public ApiResponse<List<HistoricDetailDto>> getHistoricDetailsWithHttpInfo​(String processInstanceId,
                                                                           String processInstanceIdIn,
                                                                           String executionId,
                                                                           String taskId,
                                                                           String activityInstanceId,
                                                                           String caseInstanceId,
                                                                           String caseExecutionId,
                                                                           String variableInstanceId,
                                                                           String variableTypeIn,
                                                                           String tenantIdIn,
                                                                           Boolean withoutTenantId,
                                                                           String userOperationId,
                                                                           Boolean formFields,
                                                                           Boolean variableUpdates,
                                                                           Boolean excludeTaskDetails,
                                                                           Boolean initial,
                                                                           Date occurredBefore,
                                                                           Date occurredAfter,
                                                                           String sortBy,
                                                                           String sortOrder,
                                                                           Integer firstResult,
                                                                           Integer maxResults,
                                                                           Boolean deserializeValues)
                                                                    throws ApiException
        Get Historic Details Queries for historic details that fulfill the given parameters. The size of the result set can be retrieved by using the [Get Historic Detail Count](https://docs.camunda.org/manual/7.18/reference/rest/history/detail/get-detail-query-count/) method.
        Parameters:
        processInstanceId - Filter by process instance id. (optional)
        processInstanceIdIn - Only include historic details which belong to one of the passed comma-separated process instance ids. (optional)
        executionId - Filter by execution id. (optional)
        taskId - Filter by task id. (optional)
        activityInstanceId - Filter by activity instance id. (optional)
        caseInstanceId - Filter by case instance id. (optional)
        caseExecutionId - Filter by case execution id. (optional)
        variableInstanceId - Filter by variable instance id. (optional)
        variableTypeIn - Only include historic details where the variable updates belong to one of the passed comma-separated list of variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type `serializable`. (optional)
        tenantIdIn - Filter by a comma-separated list of tenant ids. (optional)
        withoutTenantId - Only include historic details that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        userOperationId - Filter by a user operation id. (optional)
        formFields - Only include `HistoricFormFields`. Value may only be `true`, as `false` is the default behavior. (optional)
        variableUpdates - Only include `HistoricVariableUpdates`. Value may only be `true`, as `false` is the default behavior. (optional)
        excludeTaskDetails - Excludes all task-related `HistoricDetails`, so only items which have no task id set will be selected. When this parameter is used together with `taskId`, this call is ignored and task details are not excluded. Value may only be `true`, as `false` is the default behavior. (optional)
        initial - Restrict to historic variable updates that contain only initial variable values. Value may only be `true`, as `false` is the default behavior. (optional)
        occurredBefore - Restrict to historic details that occured before the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        occurredAfter - Restrict to historic details that occured after the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (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)
        deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        Returns:
        ApiResponse<List<HistoricDetailDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricDetailsAsync

        public okhttp3.Call getHistoricDetailsAsync​(String processInstanceId,
                                            String processInstanceIdIn,
                                            String executionId,
                                            String taskId,
                                            String activityInstanceId,
                                            String caseInstanceId,
                                            String caseExecutionId,
                                            String variableInstanceId,
                                            String variableTypeIn,
                                            String tenantIdIn,
                                            Boolean withoutTenantId,
                                            String userOperationId,
                                            Boolean formFields,
                                            Boolean variableUpdates,
                                            Boolean excludeTaskDetails,
                                            Boolean initial,
                                            Date occurredBefore,
                                            Date occurredAfter,
                                            String sortBy,
                                            String sortOrder,
                                            Integer firstResult,
                                            Integer maxResults,
                                            Boolean deserializeValues,
                                            ApiCallback<List<HistoricDetailDto>> _callback)
                                     throws ApiException
        Get Historic Details (asynchronously) Queries for historic details that fulfill the given parameters. The size of the result set can be retrieved by using the [Get Historic Detail Count](https://docs.camunda.org/manual/7.18/reference/rest/history/detail/get-detail-query-count/) method.
        Parameters:
        processInstanceId - Filter by process instance id. (optional)
        processInstanceIdIn - Only include historic details which belong to one of the passed comma-separated process instance ids. (optional)
        executionId - Filter by execution id. (optional)
        taskId - Filter by task id. (optional)
        activityInstanceId - Filter by activity instance id. (optional)
        caseInstanceId - Filter by case instance id. (optional)
        caseExecutionId - Filter by case execution id. (optional)
        variableInstanceId - Filter by variable instance id. (optional)
        variableTypeIn - Only include historic details where the variable updates belong to one of the passed comma-separated list of variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type `serializable`. (optional)
        tenantIdIn - Filter by a comma-separated list of tenant ids. (optional)
        withoutTenantId - Only include historic details that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        userOperationId - Filter by a user operation id. (optional)
        formFields - Only include `HistoricFormFields`. Value may only be `true`, as `false` is the default behavior. (optional)
        variableUpdates - Only include `HistoricVariableUpdates`. Value may only be `true`, as `false` is the default behavior. (optional)
        excludeTaskDetails - Excludes all task-related `HistoricDetails`, so only items which have no task id set will be selected. When this parameter is used together with `taskId`, this call is ignored and task details are not excluded. Value may only be `true`, as `false` is the default behavior. (optional)
        initial - Restrict to historic variable updates that contain only initial variable values. Value may only be `true`, as `false` is the default behavior. (optional)
        occurredBefore - Restrict to historic details that occured before the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        occurredAfter - Restrict to historic details that occured after the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (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)
        deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        _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

      • getHistoricDetailsCountCall

        public okhttp3.Call getHistoricDetailsCountCall​(String processInstanceId,
                                                String processInstanceIdIn,
                                                String executionId,
                                                String taskId,
                                                String activityInstanceId,
                                                String caseInstanceId,
                                                String caseExecutionId,
                                                String variableInstanceId,
                                                String variableTypeIn,
                                                String tenantIdIn,
                                                Boolean withoutTenantId,
                                                String userOperationId,
                                                Boolean formFields,
                                                Boolean variableUpdates,
                                                Boolean excludeTaskDetails,
                                                Boolean initial,
                                                Date occurredBefore,
                                                Date occurredAfter,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for getHistoricDetailsCount
        Parameters:
        processInstanceId - Filter by process instance id. (optional)
        processInstanceIdIn - Only include historic details which belong to one of the passed comma-separated process instance ids. (optional)
        executionId - Filter by execution id. (optional)
        taskId - Filter by task id. (optional)
        activityInstanceId - Filter by activity instance id. (optional)
        caseInstanceId - Filter by case instance id. (optional)
        caseExecutionId - Filter by case execution id. (optional)
        variableInstanceId - Filter by variable instance id. (optional)
        variableTypeIn - Only include historic details where the variable updates belong to one of the passed comma-separated list of variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type `serializable`. (optional)
        tenantIdIn - Filter by a comma-separated list of tenant ids. (optional)
        withoutTenantId - Only include historic details that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        userOperationId - Filter by a user operation id. (optional)
        formFields - Only include `HistoricFormFields`. Value may only be `true`, as `false` is the default behavior. (optional)
        variableUpdates - Only include `HistoricVariableUpdates`. Value may only be `true`, as `false` is the default behavior. (optional)
        excludeTaskDetails - Excludes all task-related `HistoricDetails`, so only items which have no task id set will be selected. When this parameter is used together with `taskId`, this call is ignored and task details are not excluded. Value may only be `true`, as `false` is the default behavior. (optional)
        initial - Restrict to historic variable updates that contain only initial variable values. Value may only be `true`, as `false` is the default behavior. (optional)
        occurredBefore - Restrict to historic details that occured before the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        occurredAfter - Restrict to historic details that occured after the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getHistoricDetailsCount

        public CountResultDto getHistoricDetailsCount​(String processInstanceId,
                                              String processInstanceIdIn,
                                              String executionId,
                                              String taskId,
                                              String activityInstanceId,
                                              String caseInstanceId,
                                              String caseExecutionId,
                                              String variableInstanceId,
                                              String variableTypeIn,
                                              String tenantIdIn,
                                              Boolean withoutTenantId,
                                              String userOperationId,
                                              Boolean formFields,
                                              Boolean variableUpdates,
                                              Boolean excludeTaskDetails,
                                              Boolean initial,
                                              Date occurredBefore,
                                              Date occurredAfter)
                                       throws ApiException
        Get Historic Detail Count Queries for the number of historic details that fulfill the given parameters. Takes the same parameters as the [Get Historic Details](https://docs.camunda.org/manual/7.18/reference/rest/history/detail/get-detail-query/) method.
        Parameters:
        processInstanceId - Filter by process instance id. (optional)
        processInstanceIdIn - Only include historic details which belong to one of the passed comma-separated process instance ids. (optional)
        executionId - Filter by execution id. (optional)
        taskId - Filter by task id. (optional)
        activityInstanceId - Filter by activity instance id. (optional)
        caseInstanceId - Filter by case instance id. (optional)
        caseExecutionId - Filter by case execution id. (optional)
        variableInstanceId - Filter by variable instance id. (optional)
        variableTypeIn - Only include historic details where the variable updates belong to one of the passed comma-separated list of variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type `serializable`. (optional)
        tenantIdIn - Filter by a comma-separated list of tenant ids. (optional)
        withoutTenantId - Only include historic details that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        userOperationId - Filter by a user operation id. (optional)
        formFields - Only include `HistoricFormFields`. Value may only be `true`, as `false` is the default behavior. (optional)
        variableUpdates - Only include `HistoricVariableUpdates`. Value may only be `true`, as `false` is the default behavior. (optional)
        excludeTaskDetails - Excludes all task-related `HistoricDetails`, so only items which have no task id set will be selected. When this parameter is used together with `taskId`, this call is ignored and task details are not excluded. Value may only be `true`, as `false` is the default behavior. (optional)
        initial - Restrict to historic variable updates that contain only initial variable values. Value may only be `true`, as `false` is the default behavior. (optional)
        occurredBefore - Restrict to historic details that occured before the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        occurredAfter - Restrict to historic details that occured after the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricDetailsCountWithHttpInfo

        public ApiResponse<CountResultDto> getHistoricDetailsCountWithHttpInfo​(String processInstanceId,
                                                                       String processInstanceIdIn,
                                                                       String executionId,
                                                                       String taskId,
                                                                       String activityInstanceId,
                                                                       String caseInstanceId,
                                                                       String caseExecutionId,
                                                                       String variableInstanceId,
                                                                       String variableTypeIn,
                                                                       String tenantIdIn,
                                                                       Boolean withoutTenantId,
                                                                       String userOperationId,
                                                                       Boolean formFields,
                                                                       Boolean variableUpdates,
                                                                       Boolean excludeTaskDetails,
                                                                       Boolean initial,
                                                                       Date occurredBefore,
                                                                       Date occurredAfter)
                                                                throws ApiException
        Get Historic Detail Count Queries for the number of historic details that fulfill the given parameters. Takes the same parameters as the [Get Historic Details](https://docs.camunda.org/manual/7.18/reference/rest/history/detail/get-detail-query/) method.
        Parameters:
        processInstanceId - Filter by process instance id. (optional)
        processInstanceIdIn - Only include historic details which belong to one of the passed comma-separated process instance ids. (optional)
        executionId - Filter by execution id. (optional)
        taskId - Filter by task id. (optional)
        activityInstanceId - Filter by activity instance id. (optional)
        caseInstanceId - Filter by case instance id. (optional)
        caseExecutionId - Filter by case execution id. (optional)
        variableInstanceId - Filter by variable instance id. (optional)
        variableTypeIn - Only include historic details where the variable updates belong to one of the passed comma-separated list of variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type `serializable`. (optional)
        tenantIdIn - Filter by a comma-separated list of tenant ids. (optional)
        withoutTenantId - Only include historic details that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        userOperationId - Filter by a user operation id. (optional)
        formFields - Only include `HistoricFormFields`. Value may only be `true`, as `false` is the default behavior. (optional)
        variableUpdates - Only include `HistoricVariableUpdates`. Value may only be `true`, as `false` is the default behavior. (optional)
        excludeTaskDetails - Excludes all task-related `HistoricDetails`, so only items which have no task id set will be selected. When this parameter is used together with `taskId`, this call is ignored and task details are not excluded. Value may only be `true`, as `false` is the default behavior. (optional)
        initial - Restrict to historic variable updates that contain only initial variable values. Value may only be `true`, as `false` is the default behavior. (optional)
        occurredBefore - Restrict to historic details that occured before the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        occurredAfter - Restrict to historic details that occured after the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getHistoricDetailsCountAsync

        public okhttp3.Call getHistoricDetailsCountAsync​(String processInstanceId,
                                                 String processInstanceIdIn,
                                                 String executionId,
                                                 String taskId,
                                                 String activityInstanceId,
                                                 String caseInstanceId,
                                                 String caseExecutionId,
                                                 String variableInstanceId,
                                                 String variableTypeIn,
                                                 String tenantIdIn,
                                                 Boolean withoutTenantId,
                                                 String userOperationId,
                                                 Boolean formFields,
                                                 Boolean variableUpdates,
                                                 Boolean excludeTaskDetails,
                                                 Boolean initial,
                                                 Date occurredBefore,
                                                 Date occurredAfter,
                                                 ApiCallback<CountResultDto> _callback)
                                          throws ApiException
        Get Historic Detail Count (asynchronously) Queries for the number of historic details that fulfill the given parameters. Takes the same parameters as the [Get Historic Details](https://docs.camunda.org/manual/7.18/reference/rest/history/detail/get-detail-query/) method.
        Parameters:
        processInstanceId - Filter by process instance id. (optional)
        processInstanceIdIn - Only include historic details which belong to one of the passed comma-separated process instance ids. (optional)
        executionId - Filter by execution id. (optional)
        taskId - Filter by task id. (optional)
        activityInstanceId - Filter by activity instance id. (optional)
        caseInstanceId - Filter by case instance id. (optional)
        caseExecutionId - Filter by case execution id. (optional)
        variableInstanceId - Filter by variable instance id. (optional)
        variableTypeIn - Only include historic details where the variable updates belong to one of the passed comma-separated list of variable types. A list of all supported variable types can be found [here](https://docs.camunda.org/manual/7.18/user-guide/process-engine/variables/#supported-variable-values). **Note:** All non-primitive variables are associated with the type `serializable`. (optional)
        tenantIdIn - Filter by a comma-separated list of tenant ids. (optional)
        withoutTenantId - Only include historic details that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
        userOperationId - Filter by a user operation id. (optional)
        formFields - Only include `HistoricFormFields`. Value may only be `true`, as `false` is the default behavior. (optional)
        variableUpdates - Only include `HistoricVariableUpdates`. Value may only be `true`, as `false` is the default behavior. (optional)
        excludeTaskDetails - Excludes all task-related `HistoricDetails`, so only items which have no task id set will be selected. When this parameter is used together with `taskId`, this call is ignored and task details are not excluded. Value may only be `true`, as `false` is the default behavior. (optional)
        initial - Restrict to historic variable updates that contain only initial variable values. Value may only be `true`, as `false` is the default behavior. (optional)
        occurredBefore - Restrict to historic details that occured before the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        occurredAfter - Restrict to historic details that occured after the given date (including the date). Default [format](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/) `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (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

      • historicDetailCall

        public okhttp3.Call historicDetailCall​(String id,
                                       Boolean deserializeValue,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for historicDetail
        Parameters:
        id - The id of the detail. (required)
        deserializeValue - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • historicDetail

        public HistoricDetailDto historicDetail​(String id,
                                        Boolean deserializeValue)
                                 throws ApiException
        Get Historic Detail Retrieves a historic detail by id.
        Parameters:
        id - The id of the detail. (required)
        deserializeValue - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        Returns:
        HistoricDetailDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • historicDetailWithHttpInfo

        public ApiResponse<HistoricDetailDto> historicDetailWithHttpInfo​(String id,
                                                                 Boolean deserializeValue)
                                                          throws ApiException
        Get Historic Detail Retrieves a historic detail by id.
        Parameters:
        id - The id of the detail. (required)
        deserializeValue - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        Returns:
        ApiResponse<HistoricDetailDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • historicDetailAsync

        public okhttp3.Call historicDetailAsync​(String id,
                                        Boolean deserializeValue,
                                        ApiCallback<HistoricDetailDto> _callback)
                                 throws ApiException
        Get Historic Detail (asynchronously) Retrieves a historic detail by id.
        Parameters:
        id - The id of the detail. (required)
        deserializeValue - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        _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

      • historicDetailBinaryCall

        public okhttp3.Call historicDetailBinaryCall​(String id,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for historicDetailBinary
        Parameters:
        id - The id of the historic variable update. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • historicDetailBinary

        public File historicDetailBinary​(String id)
                          throws ApiException
        Get Historic Detail (Binary) Retrieves the content of a historic variable update by id. Applicable for byte array and file variables.
        Parameters:
        id - The id of the historic variable update. (required)
        Returns:
        File
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • historicDetailBinaryWithHttpInfo

        public ApiResponse<File> historicDetailBinaryWithHttpInfo​(String id)
                                                   throws ApiException
        Get Historic Detail (Binary) Retrieves the content of a historic variable update by id. Applicable for byte array and file variables.
        Parameters:
        id - The id of the historic variable update. (required)
        Returns:
        ApiResponse<File>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • historicDetailBinaryAsync

        public okhttp3.Call historicDetailBinaryAsync​(String id,
                                              ApiCallback<File> _callback)
                                       throws ApiException
        Get Historic Detail (Binary) (asynchronously) Retrieves the content of a historic variable update by id. Applicable for byte array and file variables.
        Parameters:
        id - The id of the historic variable update. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • queryHistoricDetailsCall

        public okhttp3.Call queryHistoricDetailsCall​(Integer firstResult,
                                             Integer maxResults,
                                             Boolean deserializeValues,
                                             HistoricDetailQueryDto historicDetailQueryDto,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for queryHistoricDetails
        Parameters:
        firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
        maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
        deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        historicDetailQueryDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • queryHistoricDetails

        public List<HistoricDetailDto> queryHistoricDetails​(Integer firstResult,
                                                    Integer maxResults,
                                                    Boolean deserializeValues,
                                                    HistoricDetailQueryDto historicDetailQueryDto)
                                             throws ApiException
        Get Historic Details (POST) Queries for historic details that fulfill the given parameters. This method is slightly more powerful than the [Get Historic Details](https://docs.camunda.org/manual/7.18/reference/rest/history/detail/get-detail-query/) method because it allows sorting by multiple parameters. The size of the result set can be retrieved by using the [Get Historic Detail Count](https://docs.camunda.org/manual/7.18/reference/rest/history/detail/get-detail-query-count/) method.
        Parameters:
        firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
        maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
        deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        historicDetailQueryDto - (optional)
        Returns:
        List<HistoricDetailDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryHistoricDetailsWithHttpInfo

        public ApiResponse<List<HistoricDetailDto>> queryHistoricDetailsWithHttpInfo​(Integer firstResult,
                                                                             Integer maxResults,
                                                                             Boolean deserializeValues,
                                                                             HistoricDetailQueryDto historicDetailQueryDto)
                                                                      throws ApiException
        Get Historic Details (POST) Queries for historic details that fulfill the given parameters. This method is slightly more powerful than the [Get Historic Details](https://docs.camunda.org/manual/7.18/reference/rest/history/detail/get-detail-query/) method because it allows sorting by multiple parameters. The size of the result set can be retrieved by using the [Get Historic Detail Count](https://docs.camunda.org/manual/7.18/reference/rest/history/detail/get-detail-query-count/) method.
        Parameters:
        firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
        maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
        deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        historicDetailQueryDto - (optional)
        Returns:
        ApiResponse<List<HistoricDetailDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryHistoricDetailsAsync

        public okhttp3.Call queryHistoricDetailsAsync​(Integer firstResult,
                                              Integer maxResults,
                                              Boolean deserializeValues,
                                              HistoricDetailQueryDto historicDetailQueryDto,
                                              ApiCallback<List<HistoricDetailDto>> _callback)
                                       throws ApiException
        Get Historic Details (POST) (asynchronously) Queries for historic details that fulfill the given parameters. This method is slightly more powerful than the [Get Historic Details](https://docs.camunda.org/manual/7.18/reference/rest/history/detail/get-detail-query/) method because it allows sorting by multiple parameters. The size of the result set can be retrieved by using the [Get Historic Detail Count](https://docs.camunda.org/manual/7.18/reference/rest/history/detail/get-detail-query-count/) method.
        Parameters:
        firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
        maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
        deserializeValues - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default `true`). If set to `true`, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to `false`, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. **Note:** While `true` is the default value for reasons of backward compatibility, we recommend setting this parameter to `false` when developing web applications that are independent of the Java process applications deployed to the engine. (optional)
        historicDetailQueryDto - (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