Package org.camunda.community.rest.client.api

Class HistoricUserOperationLogApi

java.lang.Object
org.camunda.community.rest.client.api.HistoricUserOperationLogApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class HistoricUserOperationLogApi extends Object

  • Constructor Details

    • HistoricUserOperationLogApi

      public HistoricUserOperationLogApi()

    • HistoricUserOperationLogApi

      public HistoricUserOperationLogApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • 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 fails to make API call

    • clearAnnotationUserOperationLog

      public void clearAnnotationUserOperationLog(String operationId, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • 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, OffsetDateTime afterTimestamp, OffsetDateTime 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.21/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.21/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.21/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.21/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 fails to make API call

    • 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, OffsetDateTime afterTimestamp, OffsetDateTime beforeTimestamp, Map<String,String> additionalHeaders) 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.21/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.21/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.21/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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • 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, OffsetDateTime afterTimestamp, OffsetDateTime 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.21/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.21/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.21/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.21/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 fails to make API call

    • 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, OffsetDateTime afterTimestamp, OffsetDateTime beforeTimestamp, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders) 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.21/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.21/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.21/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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<UserOperationLogEntryDto>
      Throws:
      ApiException - if fails to make API call

    • 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 fails to make API call

    • setAnnotationUserOperationLog

      public void setAnnotationUserOperationLog(String operationId, AnnotationDto annotationDto, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call