Package org.camunda.community.rest.client.dto

Class HistoricProcessInstanceQueryDto

java.lang.Object
org.camunda.community.rest.client.dto.HistoricProcessInstanceQueryDto
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class HistoricProcessInstanceQueryDto extends Object
A historic process instance query which defines a group of historic process instances

  • Field Details

  • Constructor Details

    • HistoricProcessInstanceQueryDto

      public HistoricProcessInstanceQueryDto()

  • Method Details

    • processInstanceId

      public HistoricProcessInstanceQueryDto processInstanceId(String processInstanceId)

    • getProcessInstanceId

      @Nullable public String getProcessInstanceId()
      Filter by process instance id.
      Returns:
      processInstanceId

    • getProcessInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProcessInstanceId_JsonNullable()

    • setProcessInstanceId_JsonNullable

      public void setProcessInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processInstanceId)

    • setProcessInstanceId

      public void setProcessInstanceId(String processInstanceId)

    • processInstanceIds

      public HistoricProcessInstanceQueryDto processInstanceIds(List<String> processInstanceIds)

    • addProcessInstanceIdsItem

      public HistoricProcessInstanceQueryDto addProcessInstanceIdsItem(String processInstanceIdsItem)

    • getProcessInstanceIds

      @Nullable public List<String> getProcessInstanceIds()
      Filter by process instance ids. Must be a JSON array of `Strings`.
      Returns:
      processInstanceIds

    • getProcessInstanceIds_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<String>> getProcessInstanceIds_JsonNullable()

    • setProcessInstanceIds_JsonNullable

      public void setProcessInstanceIds_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> processInstanceIds)

    • setProcessInstanceIds

      public void setProcessInstanceIds(List<String> processInstanceIds)

    • processDefinitionId

      public HistoricProcessInstanceQueryDto processDefinitionId(String processDefinitionId)

    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      Filter by the process definition the instances run on.
      Returns:
      processDefinitionId

    • getProcessDefinitionId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProcessDefinitionId_JsonNullable()

    • setProcessDefinitionId_JsonNullable

      public void setProcessDefinitionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionId)

    • setProcessDefinitionId

      public void setProcessDefinitionId(String processDefinitionId)

    • processDefinitionKey

      public HistoricProcessInstanceQueryDto processDefinitionKey(String processDefinitionKey)

    • getProcessDefinitionKey

      @Nullable public String getProcessDefinitionKey()
      Filter by the key of the process definition the instances run on.
      Returns:
      processDefinitionKey

    • getProcessDefinitionKey_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProcessDefinitionKey_JsonNullable()

    • setProcessDefinitionKey_JsonNullable

      public void setProcessDefinitionKey_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionKey)

    • setProcessDefinitionKey

      public void setProcessDefinitionKey(String processDefinitionKey)

    • processDefinitionKeyIn

      public HistoricProcessInstanceQueryDto processDefinitionKeyIn(List<String> processDefinitionKeyIn)

    • addProcessDefinitionKeyInItem

      public HistoricProcessInstanceQueryDto addProcessDefinitionKeyInItem(String processDefinitionKeyInItem)

    • getProcessDefinitionKeyIn

      @Nullable public List<String> getProcessDefinitionKeyIn()
      Filter by a list of process definition keys. A process instance must have one of the given process definition keys. Must be a JSON array of `Strings`.
      Returns:
      processDefinitionKeyIn

    • getProcessDefinitionKeyIn_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<String>> getProcessDefinitionKeyIn_JsonNullable()

    • setProcessDefinitionKeyIn_JsonNullable

      public void setProcessDefinitionKeyIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> processDefinitionKeyIn)

    • setProcessDefinitionKeyIn

      public void setProcessDefinitionKeyIn(List<String> processDefinitionKeyIn)

    • processDefinitionName

      public HistoricProcessInstanceQueryDto processDefinitionName(String processDefinitionName)

    • getProcessDefinitionName

      @Nullable public String getProcessDefinitionName()
      Filter by the name of the process definition the instances run on.
      Returns:
      processDefinitionName

    • getProcessDefinitionName_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProcessDefinitionName_JsonNullable()

    • setProcessDefinitionName_JsonNullable

      public void setProcessDefinitionName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionName)

    • setProcessDefinitionName

      public void setProcessDefinitionName(String processDefinitionName)

    • processDefinitionNameLike

      public HistoricProcessInstanceQueryDto processDefinitionNameLike(String processDefinitionNameLike)

    • getProcessDefinitionNameLike

      @Nullable public String getProcessDefinitionNameLike()
      Filter by process definition names that the parameter is a substring of.
      Returns:
      processDefinitionNameLike

    • getProcessDefinitionNameLike_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProcessDefinitionNameLike_JsonNullable()

    • setProcessDefinitionNameLike_JsonNullable

      public void setProcessDefinitionNameLike_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processDefinitionNameLike)

    • setProcessDefinitionNameLike

      public void setProcessDefinitionNameLike(String processDefinitionNameLike)

    • processDefinitionKeyNotIn

      public HistoricProcessInstanceQueryDto processDefinitionKeyNotIn(List<String> processDefinitionKeyNotIn)

    • addProcessDefinitionKeyNotInItem

      public HistoricProcessInstanceQueryDto addProcessDefinitionKeyNotInItem(String processDefinitionKeyNotInItem)

    • getProcessDefinitionKeyNotIn

      @Nullable public List<String> getProcessDefinitionKeyNotIn()
      Exclude instances that belong to a set of process definitions. Must be a JSON array of `Strings`.
      Returns:
      processDefinitionKeyNotIn

    • getProcessDefinitionKeyNotIn_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<String>> getProcessDefinitionKeyNotIn_JsonNullable()

    • setProcessDefinitionKeyNotIn_JsonNullable

      public void setProcessDefinitionKeyNotIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> processDefinitionKeyNotIn)

    • setProcessDefinitionKeyNotIn

      public void setProcessDefinitionKeyNotIn(List<String> processDefinitionKeyNotIn)

    • processInstanceBusinessKey

      public HistoricProcessInstanceQueryDto processInstanceBusinessKey(String processInstanceBusinessKey)

    • getProcessInstanceBusinessKey

      @Nullable public String getProcessInstanceBusinessKey()
      Filter by process instance business key.
      Returns:
      processInstanceBusinessKey

    • getProcessInstanceBusinessKey_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProcessInstanceBusinessKey_JsonNullable()

    • setProcessInstanceBusinessKey_JsonNullable

      public void setProcessInstanceBusinessKey_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processInstanceBusinessKey)

    • setProcessInstanceBusinessKey

      public void setProcessInstanceBusinessKey(String processInstanceBusinessKey)

    • processInstanceBusinessKeyIn

      public HistoricProcessInstanceQueryDto processInstanceBusinessKeyIn(List<String> processInstanceBusinessKeyIn)

    • addProcessInstanceBusinessKeyInItem

      public HistoricProcessInstanceQueryDto addProcessInstanceBusinessKeyInItem(String processInstanceBusinessKeyInItem)

    • getProcessInstanceBusinessKeyIn

      @Nullable public List<String> getProcessInstanceBusinessKeyIn()
      Filter by a list of business keys. A process instance must have one of the given business keys. Must be a JSON array of `Strings`
      Returns:
      processInstanceBusinessKeyIn

    • getProcessInstanceBusinessKeyIn_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<String>> getProcessInstanceBusinessKeyIn_JsonNullable()

    • setProcessInstanceBusinessKeyIn_JsonNullable

      public void setProcessInstanceBusinessKeyIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> processInstanceBusinessKeyIn)

    • setProcessInstanceBusinessKeyIn

      public void setProcessInstanceBusinessKeyIn(List<String> processInstanceBusinessKeyIn)

    • processInstanceBusinessKeyLike

      public HistoricProcessInstanceQueryDto processInstanceBusinessKeyLike(String processInstanceBusinessKeyLike)

    • getProcessInstanceBusinessKeyLike

      @Nullable public String getProcessInstanceBusinessKeyLike()
      Filter by process instance business key that the parameter is a substring of.
      Returns:
      processInstanceBusinessKeyLike

    • getProcessInstanceBusinessKeyLike_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProcessInstanceBusinessKeyLike_JsonNullable()

    • setProcessInstanceBusinessKeyLike_JsonNullable

      public void setProcessInstanceBusinessKeyLike_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> processInstanceBusinessKeyLike)

    • setProcessInstanceBusinessKeyLike

      public void setProcessInstanceBusinessKeyLike(String processInstanceBusinessKeyLike)

    • rootProcessInstances

      public HistoricProcessInstanceQueryDto rootProcessInstances(Boolean rootProcessInstances)

    • getRootProcessInstances

      @Nullable public Boolean getRootProcessInstances()
      Restrict the query to all process instances that are top level process instances.
      Returns:
      rootProcessInstances

    • getRootProcessInstances_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getRootProcessInstances_JsonNullable()

    • setRootProcessInstances_JsonNullable

      public void setRootProcessInstances_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> rootProcessInstances)

    • setRootProcessInstances

      public void setRootProcessInstances(Boolean rootProcessInstances)

    • finished

      public HistoricProcessInstanceQueryDto finished(Boolean finished)

    • getFinished

      @Nullable public Boolean getFinished()
      Only include finished process instances. This flag includes all process instances that are completed or terminated. Value may only be `true`, as `false` is the default behavior.
      Returns:
      finished

    • getFinished_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getFinished_JsonNullable()

    • setFinished_JsonNullable

      public void setFinished_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> finished)

    • setFinished

      public void setFinished(Boolean finished)

    • unfinished

      public HistoricProcessInstanceQueryDto unfinished(Boolean unfinished)

    • getUnfinished

      @Nullable public Boolean getUnfinished()
      Only include unfinished process instances. Value may only be `true`, as `false` is the default behavior.
      Returns:
      unfinished

    • getUnfinished_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getUnfinished_JsonNullable()

    • setUnfinished_JsonNullable

      public void setUnfinished_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> unfinished)

    • setUnfinished

      public void setUnfinished(Boolean unfinished)

    • withIncidents

      public HistoricProcessInstanceQueryDto withIncidents(Boolean withIncidents)

    • getWithIncidents

      @Nullable public Boolean getWithIncidents()
      Only include process instances which have an incident. Value may only be `true`, as `false` is the default behavior.
      Returns:
      withIncidents

    • getWithIncidents_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getWithIncidents_JsonNullable()

    • setWithIncidents_JsonNullable

      public void setWithIncidents_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> withIncidents)

    • setWithIncidents

      public void setWithIncidents(Boolean withIncidents)

    • withRootIncidents

      public HistoricProcessInstanceQueryDto withRootIncidents(Boolean withRootIncidents)

    • getWithRootIncidents

      @Nullable public Boolean getWithRootIncidents()
      Only include process instances which have a root incident. Value may only be `true`, as `false` is the default behavior.
      Returns:
      withRootIncidents

    • getWithRootIncidents_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getWithRootIncidents_JsonNullable()

    • setWithRootIncidents_JsonNullable

      public void setWithRootIncidents_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> withRootIncidents)

    • setWithRootIncidents

      public void setWithRootIncidents(Boolean withRootIncidents)

    • incidentType

      public HistoricProcessInstanceQueryDto incidentType(String incidentType)

    • getIncidentType

      @Nullable public String getIncidentType()
      Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/incidents/#incident-types) for a list of incident types.
      Returns:
      incidentType

    • getIncidentType_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getIncidentType_JsonNullable()

    • setIncidentType_JsonNullable

      public void setIncidentType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> incidentType)

    • setIncidentType

      public void setIncidentType(String incidentType)

    • incidentStatus

      public HistoricProcessInstanceQueryDto incidentStatus(HistoricProcessInstanceQueryDto.IncidentStatusEnum incidentStatus)

    • getIncidentStatus

      @Nullable public HistoricProcessInstanceQueryDto.IncidentStatusEnum getIncidentStatus()
      Only include process instances which have an incident in status either open or resolved. To get all process instances, use the query parameter withIncidents.
      Returns:
      incidentStatus

    • getIncidentStatus_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<HistoricProcessInstanceQueryDto.IncidentStatusEnum> getIncidentStatus_JsonNullable()

    • setIncidentStatus_JsonNullable

      public void setIncidentStatus_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<HistoricProcessInstanceQueryDto.IncidentStatusEnum> incidentStatus)

    • setIncidentStatus

      public void setIncidentStatus(HistoricProcessInstanceQueryDto.IncidentStatusEnum incidentStatus)

    • incidentMessage

      public HistoricProcessInstanceQueryDto incidentMessage(String incidentMessage)

    • getIncidentMessage

      @Nullable public String getIncidentMessage()
      Filter by the incident message. Exact match.
      Returns:
      incidentMessage

    • getIncidentMessage_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getIncidentMessage_JsonNullable()

    • setIncidentMessage_JsonNullable

      public void setIncidentMessage_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> incidentMessage)

    • setIncidentMessage

      public void setIncidentMessage(String incidentMessage)

    • incidentMessageLike

      public HistoricProcessInstanceQueryDto incidentMessageLike(String incidentMessageLike)

    • getIncidentMessageLike

      @Nullable public String getIncidentMessageLike()
      Filter by the incident message that the parameter is a substring of.
      Returns:
      incidentMessageLike

    • getIncidentMessageLike_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getIncidentMessageLike_JsonNullable()

    • setIncidentMessageLike_JsonNullable

      public void setIncidentMessageLike_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> incidentMessageLike)

    • setIncidentMessageLike

      public void setIncidentMessageLike(String incidentMessageLike)

    • startedBefore

      public HistoricProcessInstanceQueryDto startedBefore(OffsetDateTime startedBefore)

    • getStartedBefore

      @Nullable public OffsetDateTime getStartedBefore()
      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`.
      Returns:
      startedBefore

    • getStartedBefore_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getStartedBefore_JsonNullable()

    • setStartedBefore_JsonNullable

      public void setStartedBefore_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> startedBefore)

    • setStartedBefore

      public void setStartedBefore(OffsetDateTime startedBefore)

    • startedAfter

      public HistoricProcessInstanceQueryDto startedAfter(OffsetDateTime startedAfter)

    • getStartedAfter

      @Nullable public OffsetDateTime getStartedAfter()
      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`.
      Returns:
      startedAfter

    • getStartedAfter_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getStartedAfter_JsonNullable()

    • setStartedAfter_JsonNullable

      public void setStartedAfter_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> startedAfter)

    • setStartedAfter

      public void setStartedAfter(OffsetDateTime startedAfter)

    • finishedBefore

      public HistoricProcessInstanceQueryDto finishedBefore(OffsetDateTime finishedBefore)

    • getFinishedBefore

      @Nullable public OffsetDateTime getFinishedBefore()
      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`.
      Returns:
      finishedBefore

    • getFinishedBefore_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getFinishedBefore_JsonNullable()

    • setFinishedBefore_JsonNullable

      public void setFinishedBefore_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> finishedBefore)

    • setFinishedBefore

      public void setFinishedBefore(OffsetDateTime finishedBefore)

    • finishedAfter

      public HistoricProcessInstanceQueryDto finishedAfter(OffsetDateTime finishedAfter)

    • getFinishedAfter

      @Nullable public OffsetDateTime getFinishedAfter()
      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`.
      Returns:
      finishedAfter

    • getFinishedAfter_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getFinishedAfter_JsonNullable()

    • setFinishedAfter_JsonNullable

      public void setFinishedAfter_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> finishedAfter)

    • setFinishedAfter

      public void setFinishedAfter(OffsetDateTime finishedAfter)

    • executedActivityAfter

      public HistoricProcessInstanceQueryDto executedActivityAfter(OffsetDateTime executedActivityAfter)

    • getExecutedActivityAfter

      @Nullable public OffsetDateTime getExecutedActivityAfter()
      Restrict to instances that executed an activity after the given date (inclusive). 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`.
      Returns:
      executedActivityAfter

    • getExecutedActivityAfter_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getExecutedActivityAfter_JsonNullable()

    • setExecutedActivityAfter_JsonNullable

      public void setExecutedActivityAfter_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> executedActivityAfter)

    • setExecutedActivityAfter

      public void setExecutedActivityAfter(OffsetDateTime executedActivityAfter)

    • executedActivityBefore

      public HistoricProcessInstanceQueryDto executedActivityBefore(OffsetDateTime executedActivityBefore)

    • getExecutedActivityBefore

      @Nullable public OffsetDateTime getExecutedActivityBefore()
      Restrict to instances that executed an activity before the given date (inclusive). 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`.
      Returns:
      executedActivityBefore

    • getExecutedActivityBefore_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getExecutedActivityBefore_JsonNullable()

    • setExecutedActivityBefore_JsonNullable

      public void setExecutedActivityBefore_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> executedActivityBefore)

    • setExecutedActivityBefore

      public void setExecutedActivityBefore(OffsetDateTime executedActivityBefore)

    • executedJobAfter

      public HistoricProcessInstanceQueryDto executedJobAfter(OffsetDateTime executedJobAfter)

    • getExecutedJobAfter

      @Nullable public OffsetDateTime getExecutedJobAfter()
      Restrict to instances that executed an job after the given date (inclusive). 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`.
      Returns:
      executedJobAfter

    • getExecutedJobAfter_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getExecutedJobAfter_JsonNullable()

    • setExecutedJobAfter_JsonNullable

      public void setExecutedJobAfter_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> executedJobAfter)

    • setExecutedJobAfter

      public void setExecutedJobAfter(OffsetDateTime executedJobAfter)

    • executedJobBefore

      public HistoricProcessInstanceQueryDto executedJobBefore(OffsetDateTime executedJobBefore)

    • getExecutedJobBefore

      @Nullable public OffsetDateTime getExecutedJobBefore()
      Restrict to instances that executed an job before the given date (inclusive). 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`.
      Returns:
      executedJobBefore

    • getExecutedJobBefore_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getExecutedJobBefore_JsonNullable()

    • setExecutedJobBefore_JsonNullable

      public void setExecutedJobBefore_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> executedJobBefore)

    • setExecutedJobBefore

      public void setExecutedJobBefore(OffsetDateTime executedJobBefore)

    • startedBy

      public HistoricProcessInstanceQueryDto startedBy(String startedBy)

    • getStartedBy

      @Nullable public String getStartedBy()
      Only include process instances that were started by the given user.
      Returns:
      startedBy

    • getStartedBy_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getStartedBy_JsonNullable()

    • setStartedBy_JsonNullable

      public void setStartedBy_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> startedBy)

    • setStartedBy

      public void setStartedBy(String startedBy)

    • superProcessInstanceId

      public HistoricProcessInstanceQueryDto superProcessInstanceId(String superProcessInstanceId)

    • getSuperProcessInstanceId

      @Nullable public String getSuperProcessInstanceId()
      Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id.
      Returns:
      superProcessInstanceId

    • getSuperProcessInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getSuperProcessInstanceId_JsonNullable()

    • setSuperProcessInstanceId_JsonNullable

      public void setSuperProcessInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> superProcessInstanceId)

    • setSuperProcessInstanceId

      public void setSuperProcessInstanceId(String superProcessInstanceId)

    • subProcessInstanceId

      public HistoricProcessInstanceQueryDto subProcessInstanceId(String subProcessInstanceId)

    • getSubProcessInstanceId

      @Nullable public String getSubProcessInstanceId()
      Restrict query to one process instance that has a sub process instance with the given id.
      Returns:
      subProcessInstanceId

    • getSubProcessInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getSubProcessInstanceId_JsonNullable()

    • setSubProcessInstanceId_JsonNullable

      public void setSubProcessInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> subProcessInstanceId)

    • setSubProcessInstanceId

      public void setSubProcessInstanceId(String subProcessInstanceId)

    • superCaseInstanceId

      public HistoricProcessInstanceQueryDto superCaseInstanceId(String superCaseInstanceId)

    • getSuperCaseInstanceId

      @Nullable public String getSuperCaseInstanceId()
      Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id.
      Returns:
      superCaseInstanceId

    • getSuperCaseInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getSuperCaseInstanceId_JsonNullable()

    • setSuperCaseInstanceId_JsonNullable

      public void setSuperCaseInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> superCaseInstanceId)

    • setSuperCaseInstanceId

      public void setSuperCaseInstanceId(String superCaseInstanceId)

    • subCaseInstanceId

      public HistoricProcessInstanceQueryDto subCaseInstanceId(String subCaseInstanceId)

    • getSubCaseInstanceId

      @Nullable public String getSubCaseInstanceId()
      Restrict query to one process instance that has a sub case instance with the given id.
      Returns:
      subCaseInstanceId

    • getSubCaseInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getSubCaseInstanceId_JsonNullable()

    • setSubCaseInstanceId_JsonNullable

      public void setSubCaseInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> subCaseInstanceId)

    • setSubCaseInstanceId

      public void setSubCaseInstanceId(String subCaseInstanceId)

    • caseInstanceId

      public HistoricProcessInstanceQueryDto caseInstanceId(String caseInstanceId)

    • getCaseInstanceId

      @Nullable public String getCaseInstanceId()
      Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id.
      Returns:
      caseInstanceId

    • getCaseInstanceId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getCaseInstanceId_JsonNullable()

    • setCaseInstanceId_JsonNullable

      public void setCaseInstanceId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> caseInstanceId)

    • setCaseInstanceId

      public void setCaseInstanceId(String caseInstanceId)

    • tenantIdIn

      public HistoricProcessInstanceQueryDto tenantIdIn(List<String> tenantIdIn)

    • addTenantIdInItem

      public HistoricProcessInstanceQueryDto addTenantIdInItem(String tenantIdInItem)

    • getTenantIdIn

      @Nullable public List<String> getTenantIdIn()
      Filter by a list of tenant ids. A process instance must have one of the given tenant ids. Must be a JSON array of `Strings`
      Returns:
      tenantIdIn

    • getTenantIdIn_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<String>> getTenantIdIn_JsonNullable()

    • setTenantIdIn_JsonNullable

      public void setTenantIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> tenantIdIn)

    • setTenantIdIn

      public void setTenantIdIn(List<String> tenantIdIn)

    • withoutTenantId

      public HistoricProcessInstanceQueryDto withoutTenantId(Boolean withoutTenantId)

    • getWithoutTenantId

      @Nullable public Boolean getWithoutTenantId()
      Only include historic process instances which belong to no tenant. Value may only be `true`, as `false` is the default behavior.
      Returns:
      withoutTenantId

    • getWithoutTenantId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getWithoutTenantId_JsonNullable()

    • setWithoutTenantId_JsonNullable

      public void setWithoutTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> withoutTenantId)

    • setWithoutTenantId

      public void setWithoutTenantId(Boolean withoutTenantId)

    • executedActivityIdIn

      public HistoricProcessInstanceQueryDto executedActivityIdIn(List<String> executedActivityIdIn)

    • addExecutedActivityIdInItem

      public HistoricProcessInstanceQueryDto addExecutedActivityIdInItem(String executedActivityIdInItem)

    • getExecutedActivityIdIn

      @Nullable public List<String> getExecutedActivityIdIn()
      Restrict to instances that executed an activity with one of given ids. Must be a JSON array of `Strings`
      Returns:
      executedActivityIdIn

    • getExecutedActivityIdIn_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<String>> getExecutedActivityIdIn_JsonNullable()

    • setExecutedActivityIdIn_JsonNullable

      public void setExecutedActivityIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> executedActivityIdIn)

    • setExecutedActivityIdIn

      public void setExecutedActivityIdIn(List<String> executedActivityIdIn)

    • activeActivityIdIn

      public HistoricProcessInstanceQueryDto activeActivityIdIn(List<String> activeActivityIdIn)

    • addActiveActivityIdInItem

      public HistoricProcessInstanceQueryDto addActiveActivityIdInItem(String activeActivityIdInItem)

    • getActiveActivityIdIn

      @Nullable public List<String> getActiveActivityIdIn()
      Restrict to instances that have an active activity with one of given ids. Must be a JSON array of `Strings`
      Returns:
      activeActivityIdIn

    • getActiveActivityIdIn_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<String>> getActiveActivityIdIn_JsonNullable()

    • setActiveActivityIdIn_JsonNullable

      public void setActiveActivityIdIn_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> activeActivityIdIn)

    • setActiveActivityIdIn

      public void setActiveActivityIdIn(List<String> activeActivityIdIn)

    • active

      public HistoricProcessInstanceQueryDto active(Boolean active)

    • getActive

      @Nullable public Boolean getActive()
      Restrict to instances that are active.
      Returns:
      active

    • getActive_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getActive_JsonNullable()

    • setActive_JsonNullable

      public void setActive_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> active)

    • setActive

      public void setActive(Boolean active)

    • suspended

      public HistoricProcessInstanceQueryDto suspended(Boolean suspended)

    • getSuspended

      @Nullable public Boolean getSuspended()
      Restrict to instances that are suspended.
      Returns:
      suspended

    • getSuspended_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getSuspended_JsonNullable()

    • setSuspended_JsonNullable

      public void setSuspended_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> suspended)

    • setSuspended

      public void setSuspended(Boolean suspended)

    • completed

      public HistoricProcessInstanceQueryDto completed(Boolean completed)

    • getCompleted

      @Nullable public Boolean getCompleted()
      Restrict to instances that are completed.
      Returns:
      completed

    • getCompleted_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getCompleted_JsonNullable()

    • setCompleted_JsonNullable

      public void setCompleted_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> completed)

    • setCompleted

      public void setCompleted(Boolean completed)

    • externallyTerminated

      public HistoricProcessInstanceQueryDto externallyTerminated(Boolean externallyTerminated)

    • getExternallyTerminated

      @Nullable public Boolean getExternallyTerminated()
      Restrict to instances that are externallyTerminated.
      Returns:
      externallyTerminated

    • getExternallyTerminated_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getExternallyTerminated_JsonNullable()

    • setExternallyTerminated_JsonNullable

      public void setExternallyTerminated_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> externallyTerminated)

    • setExternallyTerminated

      public void setExternallyTerminated(Boolean externallyTerminated)

    • internallyTerminated

      public HistoricProcessInstanceQueryDto internallyTerminated(Boolean internallyTerminated)

    • getInternallyTerminated

      @Nullable public Boolean getInternallyTerminated()
      Restrict to instances that are internallyTerminated.
      Returns:
      internallyTerminated

    • getInternallyTerminated_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getInternallyTerminated_JsonNullable()

    • setInternallyTerminated_JsonNullable

      public void setInternallyTerminated_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> internallyTerminated)

    • setInternallyTerminated

      public void setInternallyTerminated(Boolean internallyTerminated)

    • variables

      public HistoricProcessInstanceQueryDto variables(List<VariableQueryParameterDto> variables)

    • addVariablesItem

      public HistoricProcessInstanceQueryDto addVariablesItem(VariableQueryParameterDto variablesItem)

    • getVariables

      @Nullable public List<VariableQueryParameterDto> getVariables()
      A JSON array to only include process instances that have/had variables with certain values. The array consists of objects with the three properties `name`, `operator` and `value`. `name` (`String`) is the variable name, `operator` (`String`) is the comparison operator to be used and `value` the variable value. Value may be `String`, `Number` or `Boolean`. Valid operator values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`.
      Returns:
      variables

    • getVariables_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<VariableQueryParameterDto>> getVariables_JsonNullable()

    • setVariables_JsonNullable

      public void setVariables_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<VariableQueryParameterDto>> variables)

    • setVariables

      public void setVariables(List<VariableQueryParameterDto> variables)

    • variableNamesIgnoreCase

      public HistoricProcessInstanceQueryDto variableNamesIgnoreCase(Boolean variableNamesIgnoreCase)

    • getVariableNamesIgnoreCase

      @Nullable public Boolean getVariableNamesIgnoreCase()
      Match all variable names provided in variables case-insensitively. If set to `true` variableName and variablename are treated as equal.
      Returns:
      variableNamesIgnoreCase

    • getVariableNamesIgnoreCase_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getVariableNamesIgnoreCase_JsonNullable()

    • setVariableNamesIgnoreCase_JsonNullable

      public void setVariableNamesIgnoreCase_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> variableNamesIgnoreCase)

    • setVariableNamesIgnoreCase

      public void setVariableNamesIgnoreCase(Boolean variableNamesIgnoreCase)

    • variableValuesIgnoreCase

      public HistoricProcessInstanceQueryDto variableValuesIgnoreCase(Boolean variableValuesIgnoreCase)

    • getVariableValuesIgnoreCase

      @Nullable public Boolean getVariableValuesIgnoreCase()
      Match all variable values provided in variables case-insensitively. If set to `true` variableValue and variablevalue are treated as equal.
      Returns:
      variableValuesIgnoreCase

    • getVariableValuesIgnoreCase_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getVariableValuesIgnoreCase_JsonNullable()

    • setVariableValuesIgnoreCase_JsonNullable

      public void setVariableValuesIgnoreCase_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> variableValuesIgnoreCase)

    • setVariableValuesIgnoreCase

      public void setVariableValuesIgnoreCase(Boolean variableValuesIgnoreCase)

    • orQueries

      public HistoricProcessInstanceQueryDto orQueries(List<HistoricProcessInstanceQueryDto> orQueries)

    • addOrQueriesItem

      public HistoricProcessInstanceQueryDto addOrQueriesItem(HistoricProcessInstanceQueryDto orQueriesItem)

    • getOrQueries

      @Nullable public List<HistoricProcessInstanceQueryDto> getOrQueries()
      A JSON array of nested historic process instance queries with OR semantics. A process instance matches a nested query if it fulfills at least one of the query's predicates. With multiple nested queries, a process instance must fulfill at least one predicate of each query ([Conjunctive Normal Form](https://en.wikipedia.org/wiki/Conjunctive_normal_form)). All process instance query properties can be used except for: `sorting` See the [User Guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-engine-api/#or-queries) for more information about OR queries.
      Returns:
      orQueries

    • getOrQueries_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<HistoricProcessInstanceQueryDto>> getOrQueries_JsonNullable()

    • setOrQueries_JsonNullable

      public void setOrQueries_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<HistoricProcessInstanceQueryDto>> orQueries)

    • setOrQueries

      public void setOrQueries(List<HistoricProcessInstanceQueryDto> orQueries)

    • sorting

      public HistoricProcessInstanceQueryDto sorting(List<HistoricProcessInstanceQueryDtoSortingInner> sorting)

    • addSortingItem

      public HistoricProcessInstanceQueryDto addSortingItem(HistoricProcessInstanceQueryDtoSortingInner sortingItem)

    • getSorting

      @Nullable public List<HistoricProcessInstanceQueryDtoSortingInner> getSorting()
      Apply sorting of the result
      Returns:
      sorting

    • getSorting_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<List<HistoricProcessInstanceQueryDtoSortingInner>> getSorting_JsonNullable()

    • setSorting_JsonNullable

      public void setSorting_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<HistoricProcessInstanceQueryDtoSortingInner>> sorting)

    • setSorting

      public void setSorting(List<HistoricProcessInstanceQueryDtoSortingInner> sorting)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string