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

Class HistoricProcessDefinitionApi

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

  • Constructor Details

    • HistoricProcessDefinitionApi

      public HistoricProcessDefinitionApi()

    • HistoricProcessDefinitionApi

      public HistoricProcessDefinitionApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getCleanableHistoricProcessInstanceReport

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

    • getCleanableHistoricProcessInstanceReport

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

    • getCleanableHistoricProcessInstanceReportCount

      public CountResultDto getCleanableHistoricProcessInstanceReportCount(String processDefinitionIdIn, String processDefinitionKeyIn, String tenantIdIn, Boolean withoutTenantId, Boolean compact) throws ApiException
      Get Cleanable Process Instance Report Count Queries for the number of report results about a process definition and finished process instances relevant to history cleanup (see [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup)). Takes the same parameters as the [Get Cleanable Process Instance Report](https://docs.camunda.org/manual/7.21/reference/rest/history/process-definition/get-cleanable-process-instance-report/) method.
      Parameters:
      processDefinitionIdIn - Filter by process definition ids. Must be a comma-separated list of process definition ids. (optional)
      processDefinitionKeyIn - Filter by process definition keys. Must be a comma-separated list of process definition keys. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids. (optional)
      withoutTenantId - Only include process definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      compact - Only include process instances which have more than zero finished instances. Value may only be `true`, as `false` is the default behavior. (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getCleanableHistoricProcessInstanceReportCount

      public CountResultDto getCleanableHistoricProcessInstanceReportCount(String processDefinitionIdIn, String processDefinitionKeyIn, String tenantIdIn, Boolean withoutTenantId, Boolean compact, Map<String,String> additionalHeaders) throws ApiException
      Get Cleanable Process Instance Report Count Queries for the number of report results about a process definition and finished process instances relevant to history cleanup (see [History cleanup](https://docs.camunda.org/manual/7.21/user-guide/process-engine/history/#history-cleanup)). Takes the same parameters as the [Get Cleanable Process Instance Report](https://docs.camunda.org/manual/7.21/reference/rest/history/process-definition/get-cleanable-process-instance-report/) method.
      Parameters:
      processDefinitionIdIn - Filter by process definition ids. Must be a comma-separated list of process definition ids. (optional)
      processDefinitionKeyIn - Filter by process definition keys. Must be a comma-separated list of process definition keys. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A process definition must have one of the given tenant ids. (optional)
      withoutTenantId - Only include process definitions which belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      compact - Only include process instances which have more than zero finished instances. Value may only be `true`, as `false` is the default behavior. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricActivityStatistics

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

    • getHistoricActivityStatistics

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