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

Class HistoricDetailApi

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

  • Constructor Details

    • HistoricDetailApi

      public HistoricDetailApi()

    • HistoricDetailApi

      public HistoricDetailApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

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

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

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

    • 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, OffsetDateTime occurredBefore, OffsetDateTime occurredAfter, Map<String,String> additionalHeaders) 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.21/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.21/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.21/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.21/reference/rest/overview/date-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

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

    • historicDetail

      public HistoricDetailDto historicDetail(String id, Boolean deserializeValue, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      HistoricDetailDto
      Throws:
      ApiException - if fails to make API call

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

    • historicDetailBinary

      public File historicDetailBinary(String id, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

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

    • queryHistoricDetails

      public List<HistoricDetailDto> queryHistoricDetails(Integer firstResult, Integer maxResults, Boolean deserializeValues, HistoricDetailQueryDto historicDetailQueryDto, Map<String,String> additionalHeaders) 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.21/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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<HistoricDetailDto>
      Throws:
      ApiException - if fails to make API call