Package org.openapitools.client.api

Class HistoricUserOperationLogApi

  • public class HistoricUserOperationLogApi
extends Object

    • Constructor Detail

      • HistoricUserOperationLogApi

        public HistoricUserOperationLogApi()

      • HistoricUserOperationLogApi

        public HistoricUserOperationLogApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • clearAnnotationUserOperationLogCall

        public okhttp3.Call clearAnnotationUserOperationLogCall​(String operationId,
                                                        ApiCallback _callback)
                                                 throws ApiException
        Build call for clearAnnotationUserOperationLog
        Parameters:
        operationId - The operation id of the operation log to be updated. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • clearAnnotationUserOperationLog

        public void clearAnnotationUserOperationLog​(String operationId)
                                     throws ApiException
        Clear Annotation of an User Operation Log (Historic) Clear the annotation which was previously set for auditing reasons.
        Parameters:
        operationId - The operation id of the operation log to be updated. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • clearAnnotationUserOperationLogWithHttpInfo

        public ApiResponse<Void> clearAnnotationUserOperationLogWithHttpInfo​(String operationId)
                                                              throws ApiException
        Clear Annotation of an User Operation Log (Historic) Clear the annotation which was previously set for auditing reasons.
        Parameters:
        operationId - The operation id of the operation log to be updated. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • clearAnnotationUserOperationLogAsync

        public okhttp3.Call clearAnnotationUserOperationLogAsync​(String operationId,
                                                         ApiCallback<Void> _callback)
                                                  throws ApiException
        Clear Annotation of an User Operation Log (Historic) (asynchronously) Clear the annotation which was previously set for auditing reasons.
        Parameters:
        operationId - The operation id of the operation log to be updated. (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

      • queryUserOperationCountCall

        public okhttp3.Call queryUserOperationCountCall​(String deploymentId,
                                                String processDefinitionId,
                                                String processDefinitionKey,
                                                String processInstanceId,
                                                String executionId,
                                                String caseDefinitionId,
                                                String caseInstanceId,
                                                String caseExecutionId,
                                                String taskId,
                                                String externalTaskId,
                                                String batchId,
                                                String jobId,
                                                String jobDefinitionId,
                                                String userId,
                                                String operationId,
                                                String operationType,
                                                String entityType,
                                                String entityTypeIn,
                                                String category,
                                                String categoryIn,
                                                String property,
                                                Date afterTimestamp,
                                                Date beforeTimestamp,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for queryUserOperationCount
        Parameters:
        deploymentId - Filter by deployment id. (optional)
        processDefinitionId - Filter by process definition id. (optional)
        processDefinitionKey - Filter by process definition key. (optional)
        processInstanceId - Filter by process instance id. (optional)
        executionId - Filter by execution id. (optional)
        caseDefinitionId - Filter by case definition id. (optional)
        caseInstanceId - Filter by case instance id. (optional)
        caseExecutionId - Filter by case execution id. (optional)
        taskId - Only include operations on this task. (optional)
        externalTaskId - Only include operations on this external task. (optional)
        batchId - Only include operations on this batch. (optional)
        jobId - Filter by job id. (optional)
        jobDefinitionId - Filter by job definition id. (optional)
        userId - Only include operations of this user. (optional)
        operationId - Filter by the id of the operation. This allows fetching of multiple entries which are part of a composite operation. (optional)
        operationType - Filter by the type of the operation like `Claim` or `Delegate`. See the [Javadoc](https://docs.camunda.org/manual/7.18/reference/javadoc/?org/camunda/bpm/engine/history/UserOperationLogEntry.html) for a list of available operation types. (optional)
        entityType - Filter by the type of the entity that was affected by this operation, possible values are `Task`, `Attachment` or `IdentityLink`. (optional)
        entityTypeIn - Filter by a comma-separated list of types of the entities that was affected by this operation, possible values are `Task`, `Attachment` or `IdentityLink`. (optional)
        category - Filter by the category that this operation is associated with, possible values are `TaskWorker`, `Admin` or `Operator`. (optional)
        categoryIn - Filter by a comma-separated list of categories that this operation is associated with, possible values are `TaskWorker`, `Admin` or `Operator`. (optional)
        property - Only include operations that changed this property, e.g., `owner` or `assignee`. (optional)
        afterTimestamp - Restrict to entries that were created after the given timestamp. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the timestamp must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        beforeTimestamp - Restrict to entries that were created before the given timestamp. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the timestamp must have the 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

      • queryUserOperationCount

        public CountResultDto queryUserOperationCount​(String deploymentId,
                                              String processDefinitionId,
                                              String processDefinitionKey,
                                              String processInstanceId,
                                              String executionId,
                                              String caseDefinitionId,
                                              String caseInstanceId,
                                              String caseExecutionId,
                                              String taskId,
                                              String externalTaskId,
                                              String batchId,
                                              String jobId,
                                              String jobDefinitionId,
                                              String userId,
                                              String operationId,
                                              String operationType,
                                              String entityType,
                                              String entityTypeIn,
                                              String category,
                                              String categoryIn,
                                              String property,
                                              Date afterTimestamp,
                                              Date beforeTimestamp)
                                       throws ApiException
        Get User Operation Log Count Queries for the number of user operation log entries that fulfill the given parameters. Takes the same parameters as the [Get User Operation Log (Historic)](https://docs.camunda.org/manual/7.18/reference/rest/history/user-operation-log/get-user-operation-log-query/) method.
        Parameters:
        deploymentId - Filter by deployment id. (optional)
        processDefinitionId - Filter by process definition id. (optional)
        processDefinitionKey - Filter by process definition key. (optional)
        processInstanceId - Filter by process instance id. (optional)
        executionId - Filter by execution id. (optional)
        caseDefinitionId - Filter by case definition id. (optional)
        caseInstanceId - Filter by case instance id. (optional)
        caseExecutionId - Filter by case execution id. (optional)
        taskId - Only include operations on this task. (optional)
        externalTaskId - Only include operations on this external task. (optional)
        batchId - Only include operations on this batch. (optional)
        jobId - Filter by job id. (optional)
        jobDefinitionId - Filter by job definition id. (optional)
        userId - Only include operations of this user. (optional)
        operationId - Filter by the id of the operation. This allows fetching of multiple entries which are part of a composite operation. (optional)
        operationType - Filter by the type of the operation like `Claim` or `Delegate`. See the [Javadoc](https://docs.camunda.org/manual/7.18/reference/javadoc/?org/camunda/bpm/engine/history/UserOperationLogEntry.html) for a list of available operation types. (optional)
        entityType - Filter by the type of the entity that was affected by this operation, possible values are `Task`, `Attachment` or `IdentityLink`. (optional)
        entityTypeIn - Filter by a comma-separated list of types of the entities that was affected by this operation, possible values are `Task`, `Attachment` or `IdentityLink`. (optional)
        category - Filter by the category that this operation is associated with, possible values are `TaskWorker`, `Admin` or `Operator`. (optional)
        categoryIn - Filter by a comma-separated list of categories that this operation is associated with, possible values are `TaskWorker`, `Admin` or `Operator`. (optional)
        property - Only include operations that changed this property, e.g., `owner` or `assignee`. (optional)
        afterTimestamp - Restrict to entries that were created after the given timestamp. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the timestamp must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        beforeTimestamp - Restrict to entries that were created before the given timestamp. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the timestamp must have the 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

      • queryUserOperationCountWithHttpInfo

        public ApiResponse<CountResultDto> queryUserOperationCountWithHttpInfo​(String deploymentId,
                                                                       String processDefinitionId,
                                                                       String processDefinitionKey,
                                                                       String processInstanceId,
                                                                       String executionId,
                                                                       String caseDefinitionId,
                                                                       String caseInstanceId,
                                                                       String caseExecutionId,
                                                                       String taskId,
                                                                       String externalTaskId,
                                                                       String batchId,
                                                                       String jobId,
                                                                       String jobDefinitionId,
                                                                       String userId,
                                                                       String operationId,
                                                                       String operationType,
                                                                       String entityType,
                                                                       String entityTypeIn,
                                                                       String category,
                                                                       String categoryIn,
                                                                       String property,
                                                                       Date afterTimestamp,
                                                                       Date beforeTimestamp)
                                                                throws ApiException
        Get User Operation Log Count Queries for the number of user operation log entries that fulfill the given parameters. Takes the same parameters as the [Get User Operation Log (Historic)](https://docs.camunda.org/manual/7.18/reference/rest/history/user-operation-log/get-user-operation-log-query/) method.
        Parameters:
        deploymentId - Filter by deployment id. (optional)
        processDefinitionId - Filter by process definition id. (optional)
        processDefinitionKey - Filter by process definition key. (optional)
        processInstanceId - Filter by process instance id. (optional)
        executionId - Filter by execution id. (optional)
        caseDefinitionId - Filter by case definition id. (optional)
        caseInstanceId - Filter by case instance id. (optional)
        caseExecutionId - Filter by case execution id. (optional)
        taskId - Only include operations on this task. (optional)
        externalTaskId - Only include operations on this external task. (optional)
        batchId - Only include operations on this batch. (optional)
        jobId - Filter by job id. (optional)
        jobDefinitionId - Filter by job definition id. (optional)
        userId - Only include operations of this user. (optional)
        operationId - Filter by the id of the operation. This allows fetching of multiple entries which are part of a composite operation. (optional)
        operationType - Filter by the type of the operation like `Claim` or `Delegate`. See the [Javadoc](https://docs.camunda.org/manual/7.18/reference/javadoc/?org/camunda/bpm/engine/history/UserOperationLogEntry.html) for a list of available operation types. (optional)
        entityType - Filter by the type of the entity that was affected by this operation, possible values are `Task`, `Attachment` or `IdentityLink`. (optional)
        entityTypeIn - Filter by a comma-separated list of types of the entities that was affected by this operation, possible values are `Task`, `Attachment` or `IdentityLink`. (optional)
        category - Filter by the category that this operation is associated with, possible values are `TaskWorker`, `Admin` or `Operator`. (optional)
        categoryIn - Filter by a comma-separated list of categories that this operation is associated with, possible values are `TaskWorker`, `Admin` or `Operator`. (optional)
        property - Only include operations that changed this property, e.g., `owner` or `assignee`. (optional)
        afterTimestamp - Restrict to entries that were created after the given timestamp. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the timestamp must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        beforeTimestamp - Restrict to entries that were created before the given timestamp. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the timestamp must have the 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

      • queryUserOperationCountAsync

        public okhttp3.Call queryUserOperationCountAsync​(String deploymentId,
                                                 String processDefinitionId,
                                                 String processDefinitionKey,
                                                 String processInstanceId,
                                                 String executionId,
                                                 String caseDefinitionId,
                                                 String caseInstanceId,
                                                 String caseExecutionId,
                                                 String taskId,
                                                 String externalTaskId,
                                                 String batchId,
                                                 String jobId,
                                                 String jobDefinitionId,
                                                 String userId,
                                                 String operationId,
                                                 String operationType,
                                                 String entityType,
                                                 String entityTypeIn,
                                                 String category,
                                                 String categoryIn,
                                                 String property,
                                                 Date afterTimestamp,
                                                 Date beforeTimestamp,
                                                 ApiCallback<CountResultDto> _callback)
                                          throws ApiException
        Get User Operation Log Count (asynchronously) Queries for the number of user operation log entries that fulfill the given parameters. Takes the same parameters as the [Get User Operation Log (Historic)](https://docs.camunda.org/manual/7.18/reference/rest/history/user-operation-log/get-user-operation-log-query/) method.
        Parameters:
        deploymentId - Filter by deployment id. (optional)
        processDefinitionId - Filter by process definition id. (optional)
        processDefinitionKey - Filter by process definition key. (optional)
        processInstanceId - Filter by process instance id. (optional)
        executionId - Filter by execution id. (optional)
        caseDefinitionId - Filter by case definition id. (optional)
        caseInstanceId - Filter by case instance id. (optional)
        caseExecutionId - Filter by case execution id. (optional)
        taskId - Only include operations on this task. (optional)
        externalTaskId - Only include operations on this external task. (optional)
        batchId - Only include operations on this batch. (optional)
        jobId - Filter by job id. (optional)
        jobDefinitionId - Filter by job definition id. (optional)
        userId - Only include operations of this user. (optional)
        operationId - Filter by the id of the operation. This allows fetching of multiple entries which are part of a composite operation. (optional)
        operationType - Filter by the type of the operation like `Claim` or `Delegate`. See the [Javadoc](https://docs.camunda.org/manual/7.18/reference/javadoc/?org/camunda/bpm/engine/history/UserOperationLogEntry.html) for a list of available operation types. (optional)
        entityType - Filter by the type of the entity that was affected by this operation, possible values are `Task`, `Attachment` or `IdentityLink`. (optional)
        entityTypeIn - Filter by a comma-separated list of types of the entities that was affected by this operation, possible values are `Task`, `Attachment` or `IdentityLink`. (optional)
        category - Filter by the category that this operation is associated with, possible values are `TaskWorker`, `Admin` or `Operator`. (optional)
        categoryIn - Filter by a comma-separated list of categories that this operation is associated with, possible values are `TaskWorker`, `Admin` or `Operator`. (optional)
        property - Only include operations that changed this property, e.g., `owner` or `assignee`. (optional)
        afterTimestamp - Restrict to entries that were created after the given timestamp. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the timestamp must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        beforeTimestamp - Restrict to entries that were created before the given timestamp. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the timestamp must have the 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

      • queryUserOperationEntriesCall

        public okhttp3.Call queryUserOperationEntriesCall​(String deploymentId,
                                                  String processDefinitionId,
                                                  String processDefinitionKey,
                                                  String processInstanceId,
                                                  String executionId,
                                                  String caseDefinitionId,
                                                  String caseInstanceId,
                                                  String caseExecutionId,
                                                  String taskId,
                                                  String externalTaskId,
                                                  String batchId,
                                                  String jobId,
                                                  String jobDefinitionId,
                                                  String userId,
                                                  String operationId,
                                                  String operationType,
                                                  String entityType,
                                                  String entityTypeIn,
                                                  String category,
                                                  String categoryIn,
                                                  String property,
                                                  Date afterTimestamp,
                                                  Date beforeTimestamp,
                                                  String sortBy,
                                                  String sortOrder,
                                                  Integer firstResult,
                                                  Integer maxResults,
                                                  ApiCallback _callback)
                                           throws ApiException
        Build call for queryUserOperationEntries
        Parameters:
        deploymentId - Filter by deployment id. (optional)
        processDefinitionId - Filter by process definition id. (optional)
        processDefinitionKey - Filter by process definition key. (optional)
        processInstanceId - Filter by process instance id. (optional)
        executionId - Filter by execution id. (optional)
        caseDefinitionId - Filter by case definition id. (optional)
        caseInstanceId - Filter by case instance id. (optional)
        caseExecutionId - Filter by case execution id. (optional)
        taskId - Only include operations on this task. (optional)
        externalTaskId - Only include operations on this external task. (optional)
        batchId - Only include operations on this batch. (optional)
        jobId - Filter by job id. (optional)
        jobDefinitionId - Filter by job definition id. (optional)
        userId - Only include operations of this user. (optional)
        operationId - Filter by the id of the operation. This allows fetching of multiple entries which are part of a composite operation. (optional)
        operationType - Filter by the type of the operation like `Claim` or `Delegate`. See the [Javadoc](https://docs.camunda.org/manual/7.18/reference/javadoc/?org/camunda/bpm/engine/history/UserOperationLogEntry.html) for a list of available operation types. (optional)
        entityType - Filter by the type of the entity that was affected by this operation, possible values are `Task`, `Attachment` or `IdentityLink`. (optional)
        entityTypeIn - Filter by a comma-separated list of types of the entities that was affected by this operation, possible values are `Task`, `Attachment` or `IdentityLink`. (optional)
        category - Filter by the category that this operation is associated with, possible values are `TaskWorker`, `Admin` or `Operator`. (optional)
        categoryIn - Filter by a comma-separated list of categories that this operation is associated with, possible values are `TaskWorker`, `Admin` or `Operator`. (optional)
        property - Only include operations that changed this property, e.g., `owner` or `assignee`. (optional)
        afterTimestamp - Restrict to entries that were created after the given timestamp. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the timestamp must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        beforeTimestamp - Restrict to entries that were created before the given timestamp. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the timestamp must have the 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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • queryUserOperationEntries

        public List<UserOperationLogEntryDto> queryUserOperationEntries​(String deploymentId,
                                                                String processDefinitionId,
                                                                String processDefinitionKey,
                                                                String processInstanceId,
                                                                String executionId,
                                                                String caseDefinitionId,
                                                                String caseInstanceId,
                                                                String caseExecutionId,
                                                                String taskId,
                                                                String externalTaskId,
                                                                String batchId,
                                                                String jobId,
                                                                String jobDefinitionId,
                                                                String userId,
                                                                String operationId,
                                                                String operationType,
                                                                String entityType,
                                                                String entityTypeIn,
                                                                String category,
                                                                String categoryIn,
                                                                String property,
                                                                Date afterTimestamp,
                                                                Date beforeTimestamp,
                                                                String sortBy,
                                                                String sortOrder,
                                                                Integer firstResult,
                                                                Integer maxResults)
                                                         throws ApiException
        Get User Operation Log (Historic) Queries for user operation log entries that fulfill the given parameters. The size of the result set can be retrieved by using the [Get User Operation Log Count](https://docs.camunda.org/manual/7.18/reference/rest/history/user-operation-log/get-user-operation-log-query-count/) method. Note that the properties of operation log entries are interpreted as restrictions on the entities they apply to. That means, if a single process instance is updated, the field `processInstanceId` is populated. If a single operation updates all process instances of the same process definition, the field `processInstanceId` is `null` (a `null` restriction is viewed as a wildcard, i.e., matches a process instance with any id) and the field `processDefinitionId` is populated. This way, which entities were changed by a user operation can easily be reconstructed.
        Parameters:
        deploymentId - Filter by deployment id. (optional)
        processDefinitionId - Filter by process definition id. (optional)
        processDefinitionKey - Filter by process definition key. (optional)
        processInstanceId - Filter by process instance id. (optional)
        executionId - Filter by execution id. (optional)
        caseDefinitionId - Filter by case definition id. (optional)
        caseInstanceId - Filter by case instance id. (optional)
        caseExecutionId - Filter by case execution id. (optional)
        taskId - Only include operations on this task. (optional)
        externalTaskId - Only include operations on this external task. (optional)
        batchId - Only include operations on this batch. (optional)
        jobId - Filter by job id. (optional)
        jobDefinitionId - Filter by job definition id. (optional)
        userId - Only include operations of this user. (optional)
        operationId - Filter by the id of the operation. This allows fetching of multiple entries which are part of a composite operation. (optional)
        operationType - Filter by the type of the operation like `Claim` or `Delegate`. See the [Javadoc](https://docs.camunda.org/manual/7.18/reference/javadoc/?org/camunda/bpm/engine/history/UserOperationLogEntry.html) for a list of available operation types. (optional)
        entityType - Filter by the type of the entity that was affected by this operation, possible values are `Task`, `Attachment` or `IdentityLink`. (optional)
        entityTypeIn - Filter by a comma-separated list of types of the entities that was affected by this operation, possible values are `Task`, `Attachment` or `IdentityLink`. (optional)
        category - Filter by the category that this operation is associated with, possible values are `TaskWorker`, `Admin` or `Operator`. (optional)
        categoryIn - Filter by a comma-separated list of categories that this operation is associated with, possible values are `TaskWorker`, `Admin` or `Operator`. (optional)
        property - Only include operations that changed this property, e.g., `owner` or `assignee`. (optional)
        afterTimestamp - Restrict to entries that were created after the given timestamp. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the timestamp must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        beforeTimestamp - Restrict to entries that were created before the given timestamp. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the timestamp must have the 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)
        Returns:
        List<UserOperationLogEntryDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryUserOperationEntriesWithHttpInfo

        public ApiResponse<List<UserOperationLogEntryDto>> queryUserOperationEntriesWithHttpInfo​(String deploymentId,
                                                                                         String processDefinitionId,
                                                                                         String processDefinitionKey,
                                                                                         String processInstanceId,
                                                                                         String executionId,
                                                                                         String caseDefinitionId,
                                                                                         String caseInstanceId,
                                                                                         String caseExecutionId,
                                                                                         String taskId,
                                                                                         String externalTaskId,
                                                                                         String batchId,
                                                                                         String jobId,
                                                                                         String jobDefinitionId,
                                                                                         String userId,
                                                                                         String operationId,
                                                                                         String operationType,
                                                                                         String entityType,
                                                                                         String entityTypeIn,
                                                                                         String category,
                                                                                         String categoryIn,
                                                                                         String property,
                                                                                         Date afterTimestamp,
                                                                                         Date beforeTimestamp,
                                                                                         String sortBy,
                                                                                         String sortOrder,
                                                                                         Integer firstResult,
                                                                                         Integer maxResults)
                                                                                  throws ApiException
        Get User Operation Log (Historic) Queries for user operation log entries that fulfill the given parameters. The size of the result set can be retrieved by using the [Get User Operation Log Count](https://docs.camunda.org/manual/7.18/reference/rest/history/user-operation-log/get-user-operation-log-query-count/) method. Note that the properties of operation log entries are interpreted as restrictions on the entities they apply to. That means, if a single process instance is updated, the field `processInstanceId` is populated. If a single operation updates all process instances of the same process definition, the field `processInstanceId` is `null` (a `null` restriction is viewed as a wildcard, i.e., matches a process instance with any id) and the field `processDefinitionId` is populated. This way, which entities were changed by a user operation can easily be reconstructed.
        Parameters:
        deploymentId - Filter by deployment id. (optional)
        processDefinitionId - Filter by process definition id. (optional)
        processDefinitionKey - Filter by process definition key. (optional)
        processInstanceId - Filter by process instance id. (optional)
        executionId - Filter by execution id. (optional)
        caseDefinitionId - Filter by case definition id. (optional)
        caseInstanceId - Filter by case instance id. (optional)
        caseExecutionId - Filter by case execution id. (optional)
        taskId - Only include operations on this task. (optional)
        externalTaskId - Only include operations on this external task. (optional)
        batchId - Only include operations on this batch. (optional)
        jobId - Filter by job id. (optional)
        jobDefinitionId - Filter by job definition id. (optional)
        userId - Only include operations of this user. (optional)
        operationId - Filter by the id of the operation. This allows fetching of multiple entries which are part of a composite operation. (optional)
        operationType - Filter by the type of the operation like `Claim` or `Delegate`. See the [Javadoc](https://docs.camunda.org/manual/7.18/reference/javadoc/?org/camunda/bpm/engine/history/UserOperationLogEntry.html) for a list of available operation types. (optional)
        entityType - Filter by the type of the entity that was affected by this operation, possible values are `Task`, `Attachment` or `IdentityLink`. (optional)
        entityTypeIn - Filter by a comma-separated list of types of the entities that was affected by this operation, possible values are `Task`, `Attachment` or `IdentityLink`. (optional)
        category - Filter by the category that this operation is associated with, possible values are `TaskWorker`, `Admin` or `Operator`. (optional)
        categoryIn - Filter by a comma-separated list of categories that this operation is associated with, possible values are `TaskWorker`, `Admin` or `Operator`. (optional)
        property - Only include operations that changed this property, e.g., `owner` or `assignee`. (optional)
        afterTimestamp - Restrict to entries that were created after the given timestamp. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the timestamp must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        beforeTimestamp - Restrict to entries that were created before the given timestamp. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the timestamp must have the 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)
        Returns:
        ApiResponse<List<UserOperationLogEntryDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryUserOperationEntriesAsync

        public okhttp3.Call queryUserOperationEntriesAsync​(String deploymentId,
                                                   String processDefinitionId,
                                                   String processDefinitionKey,
                                                   String processInstanceId,
                                                   String executionId,
                                                   String caseDefinitionId,
                                                   String caseInstanceId,
                                                   String caseExecutionId,
                                                   String taskId,
                                                   String externalTaskId,
                                                   String batchId,
                                                   String jobId,
                                                   String jobDefinitionId,
                                                   String userId,
                                                   String operationId,
                                                   String operationType,
                                                   String entityType,
                                                   String entityTypeIn,
                                                   String category,
                                                   String categoryIn,
                                                   String property,
                                                   Date afterTimestamp,
                                                   Date beforeTimestamp,
                                                   String sortBy,
                                                   String sortOrder,
                                                   Integer firstResult,
                                                   Integer maxResults,
                                                   ApiCallback<List<UserOperationLogEntryDto>> _callback)
                                            throws ApiException
        Get User Operation Log (Historic) (asynchronously) Queries for user operation log entries that fulfill the given parameters. The size of the result set can be retrieved by using the [Get User Operation Log Count](https://docs.camunda.org/manual/7.18/reference/rest/history/user-operation-log/get-user-operation-log-query-count/) method. Note that the properties of operation log entries are interpreted as restrictions on the entities they apply to. That means, if a single process instance is updated, the field `processInstanceId` is populated. If a single operation updates all process instances of the same process definition, the field `processInstanceId` is `null` (a `null` restriction is viewed as a wildcard, i.e., matches a process instance with any id) and the field `processDefinitionId` is populated. This way, which entities were changed by a user operation can easily be reconstructed.
        Parameters:
        deploymentId - Filter by deployment id. (optional)
        processDefinitionId - Filter by process definition id. (optional)
        processDefinitionKey - Filter by process definition key. (optional)
        processInstanceId - Filter by process instance id. (optional)
        executionId - Filter by execution id. (optional)
        caseDefinitionId - Filter by case definition id. (optional)
        caseInstanceId - Filter by case instance id. (optional)
        caseExecutionId - Filter by case execution id. (optional)
        taskId - Only include operations on this task. (optional)
        externalTaskId - Only include operations on this external task. (optional)
        batchId - Only include operations on this batch. (optional)
        jobId - Filter by job id. (optional)
        jobDefinitionId - Filter by job definition id. (optional)
        userId - Only include operations of this user. (optional)
        operationId - Filter by the id of the operation. This allows fetching of multiple entries which are part of a composite operation. (optional)
        operationType - Filter by the type of the operation like `Claim` or `Delegate`. See the [Javadoc](https://docs.camunda.org/manual/7.18/reference/javadoc/?org/camunda/bpm/engine/history/UserOperationLogEntry.html) for a list of available operation types. (optional)
        entityType - Filter by the type of the entity that was affected by this operation, possible values are `Task`, `Attachment` or `IdentityLink`. (optional)
        entityTypeIn - Filter by a comma-separated list of types of the entities that was affected by this operation, possible values are `Task`, `Attachment` or `IdentityLink`. (optional)
        category - Filter by the category that this operation is associated with, possible values are `TaskWorker`, `Admin` or `Operator`. (optional)
        categoryIn - Filter by a comma-separated list of categories that this operation is associated with, possible values are `TaskWorker`, `Admin` or `Operator`. (optional)
        property - Only include operations that changed this property, e.g., `owner` or `assignee`. (optional)
        afterTimestamp - Restrict to entries that were created after the given timestamp. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the timestamp must have the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g., 2013-01-23T14:42:45.000+0200. (optional)
        beforeTimestamp - Restrict to entries that were created before the given timestamp. By [default](https://docs.camunda.org/manual/7.18/reference/rest/overview/date-format/), the timestamp must have the 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)
        _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

      • setAnnotationUserOperationLogCall

        public okhttp3.Call setAnnotationUserOperationLogCall​(String operationId,
                                                      AnnotationDto annotationDto,
                                                      ApiCallback _callback)
                                               throws ApiException
        Build call for setAnnotationUserOperationLog
        Parameters:
        operationId - The operation id of the operation log to be updated. (required)
        annotationDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • setAnnotationUserOperationLog

        public void setAnnotationUserOperationLog​(String operationId,
                                          AnnotationDto annotationDto)
                                   throws ApiException
        Set Annotation to an User Operation Log (Historic) Set an annotation for auditing reasons.
        Parameters:
        operationId - The operation id of the operation log to be updated. (required)
        annotationDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setAnnotationUserOperationLogWithHttpInfo

        public ApiResponse<Void> setAnnotationUserOperationLogWithHttpInfo​(String operationId,
                                                                   AnnotationDto annotationDto)
                                                            throws ApiException
        Set Annotation to an User Operation Log (Historic) Set an annotation for auditing reasons.
        Parameters:
        operationId - The operation id of the operation log to be updated. (required)
        annotationDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • setAnnotationUserOperationLogAsync

        public okhttp3.Call setAnnotationUserOperationLogAsync​(String operationId,
                                                       AnnotationDto annotationDto,
                                                       ApiCallback<Void> _callback)
                                                throws ApiException
        Set Annotation to an User Operation Log (Historic) (asynchronously) Set an annotation for auditing reasons.
        Parameters:
        operationId - The operation id of the operation log to be updated. (required)
        annotationDto - (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