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

Class HistoricDecisionInstanceApi

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

  • Constructor Details

    • HistoricDecisionInstanceApi

      public HistoricDecisionInstanceApi()

    • HistoricDecisionInstanceApi

      public HistoricDecisionInstanceApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • deleteAsync

      public BatchDto deleteAsync(DeleteHistoricDecisionInstancesDto deleteHistoricDecisionInstancesDto) throws ApiException
      Delete Async (POST) Delete multiple historic decision instances asynchronously (batch). At least `historicDecisionInstanceIds` or `historicDecisionInstanceQuery` has to be provided. If both are provided then all instances matching query criterion and instances from the list will be deleted.
      Parameters:
      deleteHistoricDecisionInstancesDto - (optional)
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • deleteAsync

      public BatchDto deleteAsync(DeleteHistoricDecisionInstancesDto deleteHistoricDecisionInstancesDto, Map<String,String> additionalHeaders) throws ApiException
      Delete Async (POST) Delete multiple historic decision instances asynchronously (batch). At least `historicDecisionInstanceIds` or `historicDecisionInstanceQuery` has to be provided. If both are provided then all instances matching query criterion and instances from the list will be deleted.
      Parameters:
      deleteHistoricDecisionInstancesDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricDecisionInstance

      public HistoricDecisionInstanceDto getHistoricDecisionInstance(String id, Boolean includeInputs, Boolean includeOutputs, Boolean disableBinaryFetching, Boolean disableCustomObjectDeserialization) throws ApiException
      Get Historic Decision Instance Retrieves a historic decision instance by id, according to the `HistoricDecisionInstance` interface in the engine.
      Parameters:
      id - The id of the historic decision instance to be retrieved. (required)
      includeInputs - Include input values in the result. Value may only be `true`, as `false` is the default behavior. (optional)
      includeOutputs - Include output values in the result. Value may only be `true`, as `false` is the default behavior. (optional)
      disableBinaryFetching - Disables fetching of byte array input and output values. Value may only be `true`, as `false` is the default behavior. (optional)
      disableCustomObjectDeserialization - Disables deserialization of input and output values that are custom objects. Value may only be `true`, as `false` is the default behavior. (optional)
      Returns:
      HistoricDecisionInstanceDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricDecisionInstance

      public HistoricDecisionInstanceDto getHistoricDecisionInstance(String id, Boolean includeInputs, Boolean includeOutputs, Boolean disableBinaryFetching, Boolean disableCustomObjectDeserialization, Map<String,String> additionalHeaders) throws ApiException
      Get Historic Decision Instance Retrieves a historic decision instance by id, according to the `HistoricDecisionInstance` interface in the engine.
      Parameters:
      id - The id of the historic decision instance to be retrieved. (required)
      includeInputs - Include input values in the result. Value may only be `true`, as `false` is the default behavior. (optional)
      includeOutputs - Include output values in the result. Value may only be `true`, as `false` is the default behavior. (optional)
      disableBinaryFetching - Disables fetching of byte array input and output values. Value may only be `true`, as `false` is the default behavior. (optional)
      disableCustomObjectDeserialization - Disables deserialization of input and output values that are custom objects. Value may only be `true`, as `false` is the default behavior. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      HistoricDecisionInstanceDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricDecisionInstances

      public List<HistoricDecisionInstanceDto> getHistoricDecisionInstances(String decisionInstanceId, String decisionInstanceIdIn, String decisionDefinitionId, String decisionDefinitionIdIn, String decisionDefinitionKey, String decisionDefinitionKeyIn, String decisionDefinitionName, String decisionDefinitionNameLike, String processDefinitionId, String processDefinitionKey, String processInstanceId, String caseDefinitionId, String caseDefinitionKey, String caseInstanceId, String activityIdIn, String activityInstanceIdIn, String tenantIdIn, Boolean withoutTenantId, OffsetDateTime evaluatedBefore, OffsetDateTime evaluatedAfter, String userId, String rootDecisionInstanceId, Boolean rootDecisionInstancesOnly, String decisionRequirementsDefinitionId, String decisionRequirementsDefinitionKey, Boolean includeInputs, Boolean includeOutputs, Boolean disableBinaryFetching, Boolean disableCustomObjectDeserialization, String sortBy, String sortOrder, Integer firstResult, Integer maxResults) throws ApiException
      Get Historic Decision Instances Queries for historic decision instances that fulfill the given parameters. The size of the result set can be retrieved by using the [Get Historic Decision Instance Count](https://docs.camunda.org/manual/7.21/reference/rest/history/decision-instance/get-decision-instance-query-count/) method.
      Parameters:
      decisionInstanceId - Filter by decision instance id. (optional)
      decisionInstanceIdIn - Filter by decision instance ids. Must be a comma-separated list of decision instance ids. (optional)
      decisionDefinitionId - Filter by the decision definition the instances belongs to. (optional)
      decisionDefinitionIdIn - Filter by the decision definitions the instances belongs to. Must be a comma-separated list of decision definition ids. (optional)
      decisionDefinitionKey - Filter by the key of the decision definition the instances belongs to. (optional)
      decisionDefinitionKeyIn - Filter by the keys of the decision definition the instances belongs to. Must be a comma- separated list of decision definition keys. (optional)
      decisionDefinitionName - Filter by the name of the decision definition the instances belongs to. (optional)
      decisionDefinitionNameLike - Filter by the name of the decision definition the instances belongs to, that the parameter is a substring of. (optional)
      processDefinitionId - Filter by the process definition the instances belongs to. (optional)
      processDefinitionKey - Filter by the key of the process definition the instances belongs to. (optional)
      processInstanceId - Filter by the process instance the instances belongs to. (optional)
      caseDefinitionId - Filter by the case definition the instances belongs to. (optional)
      caseDefinitionKey - Filter by the key of the case definition the instances belongs to. (optional)
      caseInstanceId - Filter by the case instance the instances belongs to. (optional)
      activityIdIn - Filter by the activity ids the instances belongs to. Must be a comma-separated list of acitvity ids. (optional)
      activityInstanceIdIn - Filter by the activity instance ids the instances belongs to. Must be a comma-separated list of acitvity instance ids. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A historic decision instance must have one of the given tenant ids. (optional)
      withoutTenantId - Only include historic decision instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      evaluatedBefore - Restrict to instances that were evaluated 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)
      evaluatedAfter - Restrict to instances that were evaluated 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)
      userId - Restrict to instances that were evaluated by the given user. (optional)
      rootDecisionInstanceId - Restrict to instances that have a given root decision instance id. This also includes the decision instance with the given id. (optional)
      rootDecisionInstancesOnly - Restrict to instances those are the root decision instance of an evaluation. Value may only be `true`, as `false` is the default behavior. (optional)
      decisionRequirementsDefinitionId - Filter by the decision requirements definition the instances belongs to. (optional)
      decisionRequirementsDefinitionKey - Filter by the key of the decision requirements definition the instances belongs to. (optional)
      includeInputs - Include input values in the result. Value may only be `true`, as `false` is the default behavior. (optional)
      includeOutputs - Include output values in the result. Value may only be `true`, as `false` is the default behavior. (optional)
      disableBinaryFetching - Disables fetching of byte array input and output values. Value may only be `true`, as `false` is the default behavior. (optional)
      disableCustomObjectDeserialization - Disables deserialization of input and output values that are custom objects. 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<HistoricDecisionInstanceDto>
      Throws:
      ApiException - if fails to make API call

    • getHistoricDecisionInstances

      public List<HistoricDecisionInstanceDto> getHistoricDecisionInstances(String decisionInstanceId, String decisionInstanceIdIn, String decisionDefinitionId, String decisionDefinitionIdIn, String decisionDefinitionKey, String decisionDefinitionKeyIn, String decisionDefinitionName, String decisionDefinitionNameLike, String processDefinitionId, String processDefinitionKey, String processInstanceId, String caseDefinitionId, String caseDefinitionKey, String caseInstanceId, String activityIdIn, String activityInstanceIdIn, String tenantIdIn, Boolean withoutTenantId, OffsetDateTime evaluatedBefore, OffsetDateTime evaluatedAfter, String userId, String rootDecisionInstanceId, Boolean rootDecisionInstancesOnly, String decisionRequirementsDefinitionId, String decisionRequirementsDefinitionKey, Boolean includeInputs, Boolean includeOutputs, Boolean disableBinaryFetching, Boolean disableCustomObjectDeserialization, String sortBy, String sortOrder, Integer firstResult, Integer maxResults, Map<String,String> additionalHeaders) throws ApiException
      Get Historic Decision Instances Queries for historic decision instances that fulfill the given parameters. The size of the result set can be retrieved by using the [Get Historic Decision Instance Count](https://docs.camunda.org/manual/7.21/reference/rest/history/decision-instance/get-decision-instance-query-count/) method.
      Parameters:
      decisionInstanceId - Filter by decision instance id. (optional)
      decisionInstanceIdIn - Filter by decision instance ids. Must be a comma-separated list of decision instance ids. (optional)
      decisionDefinitionId - Filter by the decision definition the instances belongs to. (optional)
      decisionDefinitionIdIn - Filter by the decision definitions the instances belongs to. Must be a comma-separated list of decision definition ids. (optional)
      decisionDefinitionKey - Filter by the key of the decision definition the instances belongs to. (optional)
      decisionDefinitionKeyIn - Filter by the keys of the decision definition the instances belongs to. Must be a comma- separated list of decision definition keys. (optional)
      decisionDefinitionName - Filter by the name of the decision definition the instances belongs to. (optional)
      decisionDefinitionNameLike - Filter by the name of the decision definition the instances belongs to, that the parameter is a substring of. (optional)
      processDefinitionId - Filter by the process definition the instances belongs to. (optional)
      processDefinitionKey - Filter by the key of the process definition the instances belongs to. (optional)
      processInstanceId - Filter by the process instance the instances belongs to. (optional)
      caseDefinitionId - Filter by the case definition the instances belongs to. (optional)
      caseDefinitionKey - Filter by the key of the case definition the instances belongs to. (optional)
      caseInstanceId - Filter by the case instance the instances belongs to. (optional)
      activityIdIn - Filter by the activity ids the instances belongs to. Must be a comma-separated list of acitvity ids. (optional)
      activityInstanceIdIn - Filter by the activity instance ids the instances belongs to. Must be a comma-separated list of acitvity instance ids. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A historic decision instance must have one of the given tenant ids. (optional)
      withoutTenantId - Only include historic decision instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      evaluatedBefore - Restrict to instances that were evaluated 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)
      evaluatedAfter - Restrict to instances that were evaluated 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)
      userId - Restrict to instances that were evaluated by the given user. (optional)
      rootDecisionInstanceId - Restrict to instances that have a given root decision instance id. This also includes the decision instance with the given id. (optional)
      rootDecisionInstancesOnly - Restrict to instances those are the root decision instance of an evaluation. Value may only be `true`, as `false` is the default behavior. (optional)
      decisionRequirementsDefinitionId - Filter by the decision requirements definition the instances belongs to. (optional)
      decisionRequirementsDefinitionKey - Filter by the key of the decision requirements definition the instances belongs to. (optional)
      includeInputs - Include input values in the result. Value may only be `true`, as `false` is the default behavior. (optional)
      includeOutputs - Include output values in the result. Value may only be `true`, as `false` is the default behavior. (optional)
      disableBinaryFetching - Disables fetching of byte array input and output values. Value may only be `true`, as `false` is the default behavior. (optional)
      disableCustomObjectDeserialization - Disables deserialization of input and output values that are custom objects. 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<HistoricDecisionInstanceDto>
      Throws:
      ApiException - if fails to make API call

    • getHistoricDecisionInstancesCount

      public CountResultDto getHistoricDecisionInstancesCount(String decisionInstanceId, String decisionInstanceIdIn, String decisionDefinitionId, String decisionDefinitionIdIn, String decisionDefinitionKey, String decisionDefinitionKeyIn, String decisionDefinitionName, String decisionDefinitionNameLike, String processDefinitionId, String processDefinitionKey, String processInstanceId, String caseDefinitionId, String caseDefinitionKey, String caseInstanceId, String activityIdIn, String activityInstanceIdIn, String tenantIdIn, Boolean withoutTenantId, OffsetDateTime evaluatedBefore, OffsetDateTime evaluatedAfter, String userId, String rootDecisionInstanceId, Boolean rootDecisionInstancesOnly, String decisionRequirementsDefinitionId, String decisionRequirementsDefinitionKey) throws ApiException
      Get Historic Decision Instance Count Queries for the number of historic decision instances that fulfill the given parameters. Takes the same parameters as the [Get Historic Decision Instances](https://docs.camunda.org/manual/7.21/reference/rest/history/decision-instance/get-decision-instance-query/) method.
      Parameters:
      decisionInstanceId - Filter by decision instance id. (optional)
      decisionInstanceIdIn - Filter by decision instance ids. Must be a comma-separated list of decision instance ids. (optional)
      decisionDefinitionId - Filter by the decision definition the instances belongs to. (optional)
      decisionDefinitionIdIn - Filter by the decision definitions the instances belongs to. Must be a comma-separated list of decision definition ids. (optional)
      decisionDefinitionKey - Filter by the key of the decision definition the instances belongs to. (optional)
      decisionDefinitionKeyIn - Filter by the keys of the decision definition the instances belongs to. Must be a comma- separated list of decision definition keys. (optional)
      decisionDefinitionName - Filter by the name of the decision definition the instances belongs to. (optional)
      decisionDefinitionNameLike - Filter by the name of the decision definition the instances belongs to, that the parameter is a substring of. (optional)
      processDefinitionId - Filter by the process definition the instances belongs to. (optional)
      processDefinitionKey - Filter by the key of the process definition the instances belongs to. (optional)
      processInstanceId - Filter by the process instance the instances belongs to. (optional)
      caseDefinitionId - Filter by the case definition the instances belongs to. (optional)
      caseDefinitionKey - Filter by the key of the case definition the instances belongs to. (optional)
      caseInstanceId - Filter by the case instance the instances belongs to. (optional)
      activityIdIn - Filter by the activity ids the instances belongs to. Must be a comma-separated list of acitvity ids. (optional)
      activityInstanceIdIn - Filter by the activity instance ids the instances belongs to. Must be a comma-separated list of acitvity instance ids. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A historic decision instance must have one of the given tenant ids. (optional)
      withoutTenantId - Only include historic decision instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      evaluatedBefore - Restrict to instances that were evaluated 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)
      evaluatedAfter - Restrict to instances that were evaluated 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)
      userId - Restrict to instances that were evaluated by the given user. (optional)
      rootDecisionInstanceId - Restrict to instances that have a given root decision instance id. This also includes the decision instance with the given id. (optional)
      rootDecisionInstancesOnly - Restrict to instances those are the root decision instance of an evaluation. Value may only be `true`, as `false` is the default behavior. (optional)
      decisionRequirementsDefinitionId - Filter by the decision requirements definition the instances belongs to. (optional)
      decisionRequirementsDefinitionKey - Filter by the key of the decision requirements definition the instances belongs to. (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getHistoricDecisionInstancesCount

      public CountResultDto getHistoricDecisionInstancesCount(String decisionInstanceId, String decisionInstanceIdIn, String decisionDefinitionId, String decisionDefinitionIdIn, String decisionDefinitionKey, String decisionDefinitionKeyIn, String decisionDefinitionName, String decisionDefinitionNameLike, String processDefinitionId, String processDefinitionKey, String processInstanceId, String caseDefinitionId, String caseDefinitionKey, String caseInstanceId, String activityIdIn, String activityInstanceIdIn, String tenantIdIn, Boolean withoutTenantId, OffsetDateTime evaluatedBefore, OffsetDateTime evaluatedAfter, String userId, String rootDecisionInstanceId, Boolean rootDecisionInstancesOnly, String decisionRequirementsDefinitionId, String decisionRequirementsDefinitionKey, Map<String,String> additionalHeaders) throws ApiException
      Get Historic Decision Instance Count Queries for the number of historic decision instances that fulfill the given parameters. Takes the same parameters as the [Get Historic Decision Instances](https://docs.camunda.org/manual/7.21/reference/rest/history/decision-instance/get-decision-instance-query/) method.
      Parameters:
      decisionInstanceId - Filter by decision instance id. (optional)
      decisionInstanceIdIn - Filter by decision instance ids. Must be a comma-separated list of decision instance ids. (optional)
      decisionDefinitionId - Filter by the decision definition the instances belongs to. (optional)
      decisionDefinitionIdIn - Filter by the decision definitions the instances belongs to. Must be a comma-separated list of decision definition ids. (optional)
      decisionDefinitionKey - Filter by the key of the decision definition the instances belongs to. (optional)
      decisionDefinitionKeyIn - Filter by the keys of the decision definition the instances belongs to. Must be a comma- separated list of decision definition keys. (optional)
      decisionDefinitionName - Filter by the name of the decision definition the instances belongs to. (optional)
      decisionDefinitionNameLike - Filter by the name of the decision definition the instances belongs to, that the parameter is a substring of. (optional)
      processDefinitionId - Filter by the process definition the instances belongs to. (optional)
      processDefinitionKey - Filter by the key of the process definition the instances belongs to. (optional)
      processInstanceId - Filter by the process instance the instances belongs to. (optional)
      caseDefinitionId - Filter by the case definition the instances belongs to. (optional)
      caseDefinitionKey - Filter by the key of the case definition the instances belongs to. (optional)
      caseInstanceId - Filter by the case instance the instances belongs to. (optional)
      activityIdIn - Filter by the activity ids the instances belongs to. Must be a comma-separated list of acitvity ids. (optional)
      activityInstanceIdIn - Filter by the activity instance ids the instances belongs to. Must be a comma-separated list of acitvity instance ids. (optional)
      tenantIdIn - Filter by a comma-separated list of tenant ids. A historic decision instance must have one of the given tenant ids. (optional)
      withoutTenantId - Only include historic decision instances that belong to no tenant. Value may only be `true`, as `false` is the default behavior. (optional)
      evaluatedBefore - Restrict to instances that were evaluated 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)
      evaluatedAfter - Restrict to instances that were evaluated 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)
      userId - Restrict to instances that were evaluated by the given user. (optional)
      rootDecisionInstanceId - Restrict to instances that have a given root decision instance id. This also includes the decision instance with the given id. (optional)
      rootDecisionInstancesOnly - Restrict to instances those are the root decision instance of an evaluation. Value may only be `true`, as `false` is the default behavior. (optional)
      decisionRequirementsDefinitionId - Filter by the decision requirements definition the instances belongs to. (optional)
      decisionRequirementsDefinitionKey - Filter by the key of the decision requirements definition the instances belongs to. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • setRemovalTimeAsyncHistoricDecisionInstance

      public BatchDto setRemovalTimeAsyncHistoricDecisionInstance(SetRemovalTimeToHistoricDecisionInstancesDto setRemovalTimeToHistoricDecisionInstancesDto) throws ApiException
      Set Removal Time Async (POST) Sets the removal time to multiple historic decision instances asynchronously (batch). At least `historicDecisionInstanceIds` or `historicDecisionInstanceQuery` has to be provided. If both are provided, all instances matching query criterion and instances from the list will be updated with a removal time.
      Parameters:
      setRemovalTimeToHistoricDecisionInstancesDto - (optional)
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • setRemovalTimeAsyncHistoricDecisionInstance

      public BatchDto setRemovalTimeAsyncHistoricDecisionInstance(SetRemovalTimeToHistoricDecisionInstancesDto setRemovalTimeToHistoricDecisionInstancesDto, Map<String,String> additionalHeaders) throws ApiException
      Set Removal Time Async (POST) Sets the removal time to multiple historic decision instances asynchronously (batch). At least `historicDecisionInstanceIds` or `historicDecisionInstanceQuery` has to be provided. If both are provided, all instances matching query criterion and instances from the list will be updated with a removal time.
      Parameters:
      setRemovalTimeToHistoricDecisionInstancesDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call