Struct camunda_client::models::historic_process_instance_query_dto::HistoricProcessInstanceQueryDto

pub struct HistoricProcessInstanceQueryDto {
    pub process_instance_id: Option<String>,
    pub process_instance_ids: Option<Vec<String>>,
    pub process_definition_id: Option<String>,
    pub process_definition_key: Option<String>,
    pub process_definition_key_in: Option<Vec<String>>,
    pub process_definition_name: Option<String>,
    pub process_definition_name_like: Option<String>,
    pub process_definition_key_not_in: Option<Vec<String>>,
    pub process_instance_business_key: Option<String>,
    pub process_instance_business_key_like: Option<String>,
    pub root_process_instances: Option<bool>,
    pub finished: Option<bool>,
    pub unfinished: Option<bool>,
    pub with_incidents: Option<bool>,
    pub with_root_incidents: Option<bool>,
    pub incident_type: Option<String>,
    pub incident_status: Option<IncidentStatus>,
    pub incident_message: Option<String>,
    pub incident_message_like: Option<String>,
    pub started_before: Option<String>,
    pub started_after: Option<String>,
    pub finished_before: Option<String>,
    pub finished_after: Option<String>,
    pub executed_activity_after: Option<String>,
    pub executed_activity_before: Option<String>,
    pub executed_job_after: Option<String>,
    pub executed_job_before: Option<String>,
    pub started_by: Option<String>,
    pub super_process_instance_id: Option<String>,
    pub sub_process_instance_id: Option<String>,
    pub super_case_instance_id: Option<String>,
    pub sub_case_instance_id: Option<String>,
    pub case_instance_id: Option<String>,
    pub tenant_id_in: Option<Vec<String>>,
    pub without_tenant_id: Option<bool>,
    pub executed_activity_id_in: Option<Vec<String>>,
    pub active_activity_id_in: Option<Vec<String>>,
    pub active: Option<bool>,
    pub suspended: Option<bool>,
    pub completed: Option<bool>,
    pub externally_terminated: Option<bool>,
    pub internally_terminated: Option<bool>,
    pub variables: Option<Vec<VariableQueryParameterDto>>,
    pub variable_names_ignore_case: Option<bool>,
    pub variable_values_ignore_case: Option<bool>,
    pub or_queries: Option<Vec<HistoricProcessInstanceQueryDto>>,
    pub sorting: Option<Vec<HistoricProcessInstanceQueryDtoSorting>>,
}

HistoricProcessInstanceQueryDto : A historic process instance query which defines a group of historic process instances

Fields

process_instance_id: Option<String>

Filter by process instance id.

process_instance_ids: Option<Vec<String>>

Filter by process instance ids. Must be a JSON array process instance ids.

process_definition_id: Option<String>

Filter by the process definition the instances run on.

process_definition_key: Option<String>

Filter by the key of the process definition the instances run on.

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.

process_definition_name: Option<String>

Filter by the name of the process definition the instances run on.

process_definition_name_like: Option<String>

Filter by process definition names that the parameter is a substring of.

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.

process_instance_business_key: Option<String>

Filter by process instance business key.

process_instance_business_key_like: Option<String>

Filter by process instance business key that the parameter is a substring of.

root_process_instances: Option<bool>

Restrict the query to all process instances that are top level process instances.

finished: Option<bool>

Only include finished process instances. Value may only be true, as false is the default behavior.

unfinished: Option<bool>

Only include unfinished process instances. Value may only be true, as false is the default behavior.

with_incidents: Option<bool>

Only include process instances which have an incident. Value may only be true, as false is the default behavior.

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.

incident_type: Option<String>

Filter by the incident type. See the User Guide for a list of incident types.

incident_status: Option<IncidentStatus>

Only include process instances which have an incident in status either open or resolved. To get all process instances, use the query parameter withIncidents.

incident_message: Option<String>

Filter by the incident message. Exact match.

incident_message_like: Option<String>

Filter by the incident message that the parameter is a substring of.

started_before: Option<String>

Restrict to instances that were started before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

started_after: Option<String>

Restrict to instances that were started after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

finished_before: Option<String>

Restrict to instances that were finished before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

finished_after: Option<String>

Restrict to instances that were finished after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

executed_activity_after: Option<String>

Restrict to instances that executed an activity after the given date (inclusive). By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

executed_activity_before: Option<String>

Restrict to instances that executed an activity before the given date (inclusive). By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

executed_job_after: Option<String>

Restrict to instances that executed an job after the given date (inclusive). By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

executed_job_before: Option<String>

Restrict to instances that executed an job before the given date (inclusive). By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

started_by: Option<String>

Only include process instances that were started by the given user.

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.

sub_process_instance_id: Option<String>

Restrict query to one process instance that has a sub process instance with the given id.

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.

sub_case_instance_id: Option<String>

Restrict query to one process instance that has a sub case instance with the given id.

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.

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.

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.

executed_activity_id_in: Option<Vec<String>>

Restrict to instances that executed an activity with one of given ids.

active_activity_id_in: Option<Vec<String>>

Restrict to instances that have an active activity with one of given ids.

active: Option<bool>

Restrict to instances that are active.

suspended: Option<bool>

Restrict to instances that are suspended.

completed: Option<bool>

Restrict to instances that are completed.

externally_terminated: Option<bool>

Restrict to instances that are externallyTerminated.

internally_terminated: Option<bool>

Restrict to instances that are internallyTerminated.

variables: Option<Vec<VariableQueryParameterDto>>

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.

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.

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.

or_queries: Option<Vec<HistoricProcessInstanceQueryDto>>

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 for more information about OR queries.

sorting: Option<Vec<HistoricProcessInstanceQueryDtoSorting>>

Apply sorting of the result

Implementations

impl HistoricProcessInstanceQueryDto

pub fn new() -> HistoricProcessInstanceQueryDto

A historic process instance query which defines a group of historic process instances

Trait Implementations

impl Clone for HistoricProcessInstanceQueryDto

fn clone(&self) -> HistoricProcessInstanceQueryDto

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HistoricProcessInstanceQueryDto

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HistoricProcessInstanceQueryDto

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<HistoricProcessInstanceQueryDto> for HistoricProcessInstanceQueryDto

fn eq(&self, other: &HistoricProcessInstanceQueryDto) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HistoricProcessInstanceQueryDto) -> bool

This method tests for !=.

impl Serialize for HistoricProcessInstanceQueryDto

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HistoricProcessInstanceQueryDto