# HistoricProcessInstanceQueryDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**process_instance_id** | Option<**String**> | Filter by process instance id. | [optional]
**process_instance_ids** | Option<**Vec<String>**> | Filter by process instance ids. Must be a JSON array process instance ids. | [optional]
**process_definition_id** | Option<**String**> | Filter by the process definition the instances run on. | [optional]
**process_definition_key** | Option<**String**> | Filter by the key of the process definition the instances run on. | [optional]
**process_definition_key_in** | Option<**Vec<String>**> | 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. | [optional]
**process_definition_name** | Option<**String**> | Filter by the name of the process definition the instances run on. | [optional]
**process_definition_name_like** | Option<**String**> | Filter by process definition names that the parameter is a substring of. | [optional]
**process_definition_key_not_in** | Option<**Vec<String>**> | Exclude instances that belong to a set of process definitions. Must be a JSON array of process definition keys. | [optional]
**process_instance_business_key** | Option<**String**> | Filter by process instance business key. | [optional]
**process_instance_business_key_like** | Option<**String**> | Filter by process instance business key that the parameter is a substring of. | [optional]
**root_process_instances** | Option<**bool**> | Restrict the query to all process instances that are top level process instances. | [optional]
**finished** | Option<**bool**> | Only include finished process instances. Value may only be true, as false is the default behavior. | [optional][default to false]
**unfinished** | Option<**bool**> | Only include unfinished process instances. Value may only be true, as false is the default behavior. | [optional][default to false]
**with_incidents** | Option<**bool**> | Only include process instances which have an incident. Value may only be true, as false is the default behavior. | [optional][default to false]
**with_root_incidents** | Option<**bool**> | Only include process instances which have a root incident. Value may only be true, as false is the default behavior. | [optional][default to false]
**incident_type** | Option<**String**> | Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types. | [optional]
**incident_status** | Option<**String**> | Only include process instances which have an incident in status either open or resolved. To get all process instances, use the query parameter withIncidents. | [optional]
**incident_message** | Option<**String**> | Filter by the incident message. Exact match. | [optional]
**incident_message_like** | Option<**String**> | Filter by the incident message that the parameter is a substring of. | [optional]
**started_before** | Option<**String**> | Restrict to instances that were started before the given date. By [default](https://docs.camunda.org/manual/7.13/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]
**started_after** | Option<**String**> | Restrict to instances that were started after the given date. By [default](https://docs.camunda.org/manual/7.13/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]
**finished_before** | Option<**String**> | Restrict to instances that were finished before the given date. By [default](https://docs.camunda.org/manual/7.13/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]
**finished_after** | Option<**String**> | Restrict to instances that were finished after the given date. By [default](https://docs.camunda.org/manual/7.13/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]
**executed_activity_after** | Option<**String**> | Restrict to instances that executed an activity after the given date (inclusive). By [default](https://docs.camunda.org/manual/7.13/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]
**executed_activity_before** | Option<**String**> | Restrict to instances that executed an activity before the given date (inclusive). By [default](https://docs.camunda.org/manual/7.13/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]
**executed_job_after** | Option<**String**> | Restrict to instances that executed an job after the given date (inclusive). By [default](https://docs.camunda.org/manual/7.13/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]
**executed_job_before** | Option<**String**> | Restrict to instances that executed an job before the given date (inclusive). By [default](https://docs.camunda.org/manual/7.13/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]
**started_by** | Option<**String**> | Only include process instances that were started by the given user. | [optional]
**super_process_instance_id** | Option<**String**> | Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. | [optional]
**sub_process_instance_id** | Option<**String**> | Restrict query to one process instance that has a sub process instance with the given id. | [optional]
**super_case_instance_id** | Option<**String**> | Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. | [optional]
**sub_case_instance_id** | Option<**String**> | Restrict query to one process instance that has a sub case instance with the given id. | [optional]
**case_instance_id** | Option<**String**> | Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. | [optional]
**tenant_id_in** | Option<**Vec<String>**> | 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. | [optional]
**without_tenant_id** | Option<**bool**> | Only include historic process instances which belong to no tenant. Value may only be true, as false is the default behavior. | [optional]
**executed_activity_id_in** | Option<**Vec<String>**> | Restrict to instances that executed an activity with one of given ids. | [optional]
**active_activity_id_in** | Option<**Vec<String>**> | Restrict to instances that have an active activity with one of given ids. | [optional]
**active** | Option<**bool**> | Restrict to instances that are active. | [optional]
**suspended** | Option<**bool**> | Restrict to instances that are suspended. | [optional]
**completed** | Option<**bool**> | Restrict to instances that are completed. | [optional]
**externally_terminated** | Option<**bool**> | Restrict to instances that are externallyTerminated. | [optional]
**internally_terminated** | Option<**bool**> | Restrict to instances that are internallyTerminated. | [optional]
**variables** | Option<[**Vec<crate::models::VariableQueryParameterDto>**](VariableQueryParameterDto.md)> | 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`. | [optional]
**variable_names_ignore_case** | Option<**bool**> | Match all variable names provided in variables case-insensitively. If set to true variableName and variablename are treated as equal. | [optional]
**variable_values_ignore_case** | Option<**bool**> | Match all variable values provided in variables case-insensitively. If set to true variableValue and variablevalue are treated as equal. | [optional]
**or_queries** | Option<[**Vec<crate::models::HistoricProcessInstanceQueryDto>**](HistoricProcessInstanceQueryDto.md)> | 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). All process instance query properties can be used except for: sorting See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/process-engine-api/#or-queries) for more information about OR queries. | [optional]
**sorting** | Option<[**Vec<crate::models::HistoricProcessInstanceQueryDtoSorting>**](HistoricProcessInstanceQueryDto_sorting.md)> | Apply sorting of the result | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)