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

Class HistoricActivityInstanceApi

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

  • Constructor Details

    • HistoricActivityInstanceApi

      public HistoricActivityInstanceApi()

    • HistoricActivityInstanceApi

      public HistoricActivityInstanceApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHistoricActivityInstance

      public HistoricActivityInstanceDto getHistoricActivityInstance(String id) throws ApiException
      Get Retrieves a historic activity instance by id, according to the `HistoricActivityInstance` interface in the engine.
      Parameters:
      id - The id of the historic activity instance to be retrieved. (required)
      Returns:
      HistoricActivityInstanceDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricActivityInstance

      public HistoricActivityInstanceDto getHistoricActivityInstance(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Retrieves a historic activity instance by id, according to the `HistoricActivityInstance` interface in the engine.
      Parameters:
      id - The id of the historic activity instance to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      HistoricActivityInstanceDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricActivityInstances

      public List<HistoricActivityInstanceDto> getHistoricActivityInstances(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String activityInstanceId, String processInstanceId, String processDefinitionId, String executionId, String activityId, String activityName, String activityType, String taskAssignee, Boolean finished, Boolean unfinished, Boolean canceled, Boolean completeScope, OffsetDateTime startedBefore, OffsetDateTime startedAfter, OffsetDateTime finishedBefore, OffsetDateTime finishedAfter, String tenantIdIn, Boolean withoutTenantId) throws ApiException
      Get List Queries for historic activity instances that fulfill the given parameters. The size of the result set can be retrieved by using the [Get Historic Activity Instance Count](https://docs.camunda.org/manual/7.21/reference/rest/history/activity-instance/get-activity-instance-query-count/) method.
      Parameters:
      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)
      activityInstanceId - Filter by activity instance id. (optional)
      processInstanceId - Filter by process instance id. (optional)
      processDefinitionId - Filter by process definition id. (optional)
      executionId - Filter by the id of the execution that executed the activity instance. (optional)
      activityId - Filter by the activity id (according to BPMN 2.0 XML). (optional)
      activityName - Filter by the activity name (according to BPMN 2.0 XML). (optional)
      activityType - Filter by activity type. (optional)
      taskAssignee - Only include activity instances that are user tasks and assigned to a given user. (optional)
      finished - Only include finished activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set. (optional)
      unfinished - Only include unfinished activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set. (optional)
      canceled - Only include canceled activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set. (optional)
      completeScope - Only include activity instances which completed a scope. Value may only be `true`, as `false` behaves the same as when the property is not set. (optional)
      startedBefore - Restrict to 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 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 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 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)
      tenantIdIn - Filter by a comma-separated list of ids. An activity instance must have one of the given tenant ids. (optional)
      withoutTenantId - Only include historic activity instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      Returns:
      List<HistoricActivityInstanceDto>
      Throws:
      ApiException - if fails to make API call

    • getHistoricActivityInstances

      public List<HistoricActivityInstanceDto> getHistoricActivityInstances(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String activityInstanceId, String processInstanceId, String processDefinitionId, String executionId, String activityId, String activityName, String activityType, String taskAssignee, Boolean finished, Boolean unfinished, Boolean canceled, Boolean completeScope, OffsetDateTime startedBefore, OffsetDateTime startedAfter, OffsetDateTime finishedBefore, OffsetDateTime finishedAfter, String tenantIdIn, Boolean withoutTenantId, Map<String,String> additionalHeaders) throws ApiException
      Get List Queries for historic activity instances that fulfill the given parameters. The size of the result set can be retrieved by using the [Get Historic Activity Instance Count](https://docs.camunda.org/manual/7.21/reference/rest/history/activity-instance/get-activity-instance-query-count/) method.
      Parameters:
      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)
      activityInstanceId - Filter by activity instance id. (optional)
      processInstanceId - Filter by process instance id. (optional)
      processDefinitionId - Filter by process definition id. (optional)
      executionId - Filter by the id of the execution that executed the activity instance. (optional)
      activityId - Filter by the activity id (according to BPMN 2.0 XML). (optional)
      activityName - Filter by the activity name (according to BPMN 2.0 XML). (optional)
      activityType - Filter by activity type. (optional)
      taskAssignee - Only include activity instances that are user tasks and assigned to a given user. (optional)
      finished - Only include finished activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set. (optional)
      unfinished - Only include unfinished activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set. (optional)
      canceled - Only include canceled activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set. (optional)
      completeScope - Only include activity instances which completed a scope. Value may only be `true`, as `false` behaves the same as when the property is not set. (optional)
      startedBefore - Restrict to 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 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 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 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)
      tenantIdIn - Filter by a comma-separated list of ids. An activity instance must have one of the given tenant ids. (optional)
      withoutTenantId - Only include historic activity instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<HistoricActivityInstanceDto>
      Throws:
      ApiException - if fails to make API call

    • getHistoricActivityInstancesCount

      public CountResultDto getHistoricActivityInstancesCount(String activityInstanceId, String processInstanceId, String processDefinitionId, String executionId, String activityId, String activityName, String activityType, String taskAssignee, Boolean finished, Boolean unfinished, Boolean canceled, Boolean completeScope, OffsetDateTime startedBefore, OffsetDateTime startedAfter, OffsetDateTime finishedBefore, OffsetDateTime finishedAfter, String tenantIdIn, Boolean withoutTenantId) throws ApiException
      Get List Count Queries for the number of historic activity instances that fulfill the given parameters. Takes the same parameters as the [Get Historic Activity Instance](https://docs.camunda.org/manual/7.21/reference/rest/history/activity-instance/get-activity-instance-query/) method.
      Parameters:
      activityInstanceId - Filter by activity instance id. (optional)
      processInstanceId - Filter by process instance id. (optional)
      processDefinitionId - Filter by process definition id. (optional)
      executionId - Filter by the id of the execution that executed the activity instance. (optional)
      activityId - Filter by the activity id (according to BPMN 2.0 XML). (optional)
      activityName - Filter by the activity name (according to BPMN 2.0 XML). (optional)
      activityType - Filter by activity type. (optional)
      taskAssignee - Only include activity instances that are user tasks and assigned to a given user. (optional)
      finished - Only include finished activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set. (optional)
      unfinished - Only include unfinished activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set. (optional)
      canceled - Only include canceled activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set. (optional)
      completeScope - Only include activity instances which completed a scope. Value may only be `true`, as `false` behaves the same as when the property is not set. (optional)
      startedBefore - Restrict to 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 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 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 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)
      tenantIdIn - Filter by a comma-separated list of ids. An activity instance must have one of the given tenant ids. (optional)
      withoutTenantId - Only include historic activity instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricActivityInstancesCount

      public CountResultDto getHistoricActivityInstancesCount(String activityInstanceId, String processInstanceId, String processDefinitionId, String executionId, String activityId, String activityName, String activityType, String taskAssignee, Boolean finished, Boolean unfinished, Boolean canceled, Boolean completeScope, OffsetDateTime startedBefore, OffsetDateTime startedAfter, OffsetDateTime finishedBefore, OffsetDateTime finishedAfter, String tenantIdIn, Boolean withoutTenantId, Map<String,String> additionalHeaders) throws ApiException
      Get List Count Queries for the number of historic activity instances that fulfill the given parameters. Takes the same parameters as the [Get Historic Activity Instance](https://docs.camunda.org/manual/7.21/reference/rest/history/activity-instance/get-activity-instance-query/) method.
      Parameters:
      activityInstanceId - Filter by activity instance id. (optional)
      processInstanceId - Filter by process instance id. (optional)
      processDefinitionId - Filter by process definition id. (optional)
      executionId - Filter by the id of the execution that executed the activity instance. (optional)
      activityId - Filter by the activity id (according to BPMN 2.0 XML). (optional)
      activityName - Filter by the activity name (according to BPMN 2.0 XML). (optional)
      activityType - Filter by activity type. (optional)
      taskAssignee - Only include activity instances that are user tasks and assigned to a given user. (optional)
      finished - Only include finished activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set. (optional)
      unfinished - Only include unfinished activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set. (optional)
      canceled - Only include canceled activity instances. Value may only be `true`, as `false` behaves the same as when the property is not set. (optional)
      completeScope - Only include activity instances which completed a scope. Value may only be `true`, as `false` behaves the same as when the property is not set. (optional)
      startedBefore - Restrict to 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 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 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 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)
      tenantIdIn - Filter by a comma-separated list of ids. An activity instance must have one of the given tenant ids. (optional)
      withoutTenantId - Only include historic activity instances that belong to no tenant. 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

    • queryHistoricActivityInstances

      public List<HistoricActivityInstanceDto> queryHistoricActivityInstances(Integer firstResult, Integer maxResults, HistoricActivityInstanceQueryDto historicActivityInstanceQueryDto) throws ApiException
      Get List (POST) Queries for historic activity instances that fulfill the given parameters. The size of the result set can be retrieved by using the [Get Historic Activity Instance Count](https://docs.camunda.org/manual/7.21/reference/rest/history/activity-instance/get-activity-instance-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)
      historicActivityInstanceQueryDto - (optional)
      Returns:
      List<HistoricActivityInstanceDto>
      Throws:
      ApiException - if fails to make API call

    • queryHistoricActivityInstances

      public List<HistoricActivityInstanceDto> queryHistoricActivityInstances(Integer firstResult, Integer maxResults, HistoricActivityInstanceQueryDto historicActivityInstanceQueryDto, Map<String,String> additionalHeaders) throws ApiException
      Get List (POST) Queries for historic activity instances that fulfill the given parameters. The size of the result set can be retrieved by using the [Get Historic Activity Instance Count](https://docs.camunda.org/manual/7.21/reference/rest/history/activity-instance/get-activity-instance-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)
      historicActivityInstanceQueryDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<HistoricActivityInstanceDto>
      Throws:
      ApiException - if fails to make API call

    • queryHistoricActivityInstancesCount

      public CountResultDto queryHistoricActivityInstancesCount(HistoricActivityInstanceQueryDto historicActivityInstanceQueryDto) throws ApiException
      Get List Count (POST) Queries for the number of historic activity instances that fulfill the given parameters.
      Parameters:
      historicActivityInstanceQueryDto - (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • queryHistoricActivityInstancesCount

      public CountResultDto queryHistoricActivityInstancesCount(HistoricActivityInstanceQueryDto historicActivityInstanceQueryDto, Map<String,String> additionalHeaders) throws ApiException
      Get List Count (POST) Queries for the number of historic activity instances that fulfill the given parameters.
      Parameters:
      historicActivityInstanceQueryDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call